At the MODX Meetup in Amsterdam last week, I gave a talk about an ongoing initiative to improve the MODX documentation.
The slides can be found here: https://www.slideshare.net/hamstramark1/improving-the-modx-documentation-march-29-2019
The primary premise of that talk is that everyone should be able of helping out with the new documentation. It’s based on markdown files stored in github, with support for different version branches (2.x, 3.x) as well as multiple languages.
Most coordination around this effort happens on Slack, in the #documentation channel, which I’d like to invite everyone to join. Discrete tasks and to dos are also listed in the Docs repository (for work that needs to be done on the content) and DocsApp repository (for work that needs to be done on the application/site that serves the documentation).
As not everyone is on Slack, I figured I’d open this topic for questions/ideas about the initiative as well.
Most important links:
- The new documentation site in action: https://docs.modx.org/
- The new content, in markdown: https://github.com/modxorg/Docs
- The new site, a Slim application: https://github.com/modxorg/DocsApp
The slides from my talk include a bit more information on the why/how of this initiative.