First, I understand what you mean, but also what @udono means. So I want to propose a few changes with the main goal to make it clear to the users what to do when they spot some typos or want to make changes to the documentation. Generally it kind of ‘separates’ the documentation from the code.
-
I haven’t tried the online editor in heptapod, but when users can use that functionality for documentation, will be a big win. They don’t need to clone the repository and do things they don’t like. Question is, will this work with how the repository is set up etc.
-
Add a section on the ‘contribute’ page on the website. There is a section about submitting changes, but I also think something like that should also be there for documentation and mention specifically the online editor and tell how the workflow of documentation goes. Maybe duplicating text, but it’s way more clear and more specific. Some users want to contribute writing documentation but don’t find specific information about how to start.
-
Make clear what kind of documentation you expect. For example I installed and configured SAML with ADFS and want to create a small document to walk you through the setup and where to look which means talking a bit about PySaml. Is this kind of tutorial allowed to get in?
-
The edit button on the documentation itself is hidden in a mouse-over popup. Maybe it can be always show near the search or fullscreen button. BTW, the ‘suggest edit’ doesn’t work and gives a 500 error on heptapod.