[Mayan EDMS: 1702] Help with new Mayan manual

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[Mayan EDMS: 1702] Help with new Mayan manual

Another plan for the next version is to move the documention into its own repository/project.
This way users wanting to help with the documentation don't need to checkout the entire code repository.

Along with the move to a separate project, I thought it would be good to update the markup language used to
AsciiDoc which produces much better documentation and can be used to generate print ready results as you can see in the
repository screenshot.

While AsciiDoc is a superior markup language, it is also more complicated and less supported by editors. 
This is why along with many suggestions the new documentation should use a simpler markup language like

So those are the two initial goals for the documentation in the following months:

- Move all files to a the new location at:  https://gitlab.com/mayan-edms/manual
- Convert as much as possible from RestructuredText to Markdown

Later on:
- Use a browser automation tool and Docker to generate automatic screenshots.
- Refocus/rewrite the documentation as a user manual.

If you think/want to help with these goals check the new documentation repository at https://gitlab.com/mayan-edms/manual


You received this message because you are subscribed to the Google Groups "Mayan EDMS" group.
To unsubscribe from this group and stop receiving emails from it, send an email to [hidden email].
For more options, visit https://groups.google.com/d/optout.