You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Some discussion has been generated at #146 around how regular users and developers can use current documentation, and some ideas came up from that discussion:
This software is used by different user types
regular users, which only want to execute and use the application
developers, which want to contribute to the project.
Regular users want to install this software as fast as possible
Developers want to clone the repo and start developing as fast as possible
Actually, the project documentation is dispersed in 3 source points: README file, Wiki and Front Page (manual)
Some contents in the documentation are obsolete or duplicated
So, I would suggest to re-structure current documentation by following next steps:
Remove current Wiki, as it mainly contains obsolete information and interesting information can be moved to README and/or Front Page.
Re-organize current README and Front Page
Add new contents to documentation
Remove obsolete content from final documentation:
Wiki > Installation instructions > Binary packages
Some discussion has been generated at #146 around how regular users and developers can use current documentation, and some ideas came up from that discussion:
So, I would suggest to re-structure current documentation by following next steps:
A proposal for a new organization for README and Front Page, including new contents, can be seen at Proposal for new organization of the documentation.pdf
What do you think about this?
The text was updated successfully, but these errors were encountered: