Our documentation site at https://docs.classicpress.net is now serving content based on the Markdown files stored at https://github.com/ClassicPress/ClassicPress-docs, and we are ready to welcome your contributions here, such as cleaning up outdated or duplicated content.
How to contribute
At the bottom of each page on docs.classicpress.net, you will see a new link to “Edit this page on GitHub”.
When you click this link, you’ll be prompted to log in to GitHub and submit a change back to the original version of the file as a GitHub pull request.
The idea of this contribution workflow is that anyone can propose changes to the documentation site without requiring special access. Also, via issues and pull requests, GitHub gives us the tools to discuss and iterate on any changes before accepting them, and a full, public revision history of the content stored there.
I think using the GitHub web interface to make an improvement to our documentation would be a good topic to write a tutorial on
Previously, our documentation site has just been a normal, vanilla ClassicPress site. This has worked well but it has meant that anyone who contributes to our documentation needs to have a privileged user account on the site.
This new contribution workflow is an experiment, but I hope it will allow more people to contribute to our documentation and also serve as the base for further efforts here, like building a code reference.
These changes have previously been planned and discussed in Slack in the #docs channel, which is also a good place to ask any questions about any of this. Thanks to @timkaye and @ElisabettaCarrara for helping with the process of converting our documentation content to Markdown.
There is more documentation about how this system works linked from the GitHub repository at https://github.com/ClassicPress/ClassicPress-docs.
Let me know your thoughts