Documentation for PR Topic is solved

[MarkRS]

I've some hope that my PR (#41496) may eventually find its way into the core so I want to write documentation for it, as the repo makes a point of requesting. Unfortunately I've not been able to find out how or where to do that. Could somebody point me in the right direction please.

Many thanks

[ceford]

https://manual.joomla.org/docs/get-started/

[MarkRS]

Thanks for that ceford.
I may be being thick, but I can't see where that tells me how to write & submit documentation to support a change to core functionality. I did find it previously and looked.

[SharkyKZ]

The manual is the place to add documentation for new features. Its repository is here https://github.com/joomla/Manual. Other places affected by your changes should also be updated. For example, component development pages mentioning access.xml/config.xml structure.

[MarkRS]

Thanks for that SharkyKZ.

So it looks like editing is done by clicking the "Edit this page" link in the manual that you and ceford pointed me to, yes?

If so, how do I go about adding a page? I've had a look at the github repo directly and can't for the life of me work out how to do it there and I don't see an "add a new page" link in the manual.

My PR is about making access to component options controllable with the ACL model. I can't find anything about the options system in general in the manual. Again, perhaps I'm just not looking properly.

Mark

[ceford]

It's the same as contributing to code: fork the repo, clone your copy, make a branch and then a PR with your changes.

[dziller]

If you follow Ceford's tip, you will end up with an exact image of the GH repo on your local computer. Don't forget the step with the new branch.

The content of the current manual website is provided by the folder /versioned_docs/version-5.1/. Your new article should be inserted in the appropriate subfolder there.
If you are wondering which is the correct subfolder for your new content, it would be useful to ask the maintainers with an issue how to proceed in your case.
You can also ask this question in the documentation channel on Mattermost.

[MarkRS]

Thank you dziller, that's very helpful.