Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Re-organize and improve current documentation #176

Open
nayraq80 opened this issue Sep 24, 2020 · 0 comments
Open

Re-organize and improve current documentation #176

nayraq80 opened this issue Sep 24, 2020 · 0 comments

Comments

@nayraq80
Copy link

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:

  1. Remove current Wiki, as it mainly contains obsolete information and interesting information can be moved to README and/or Front Page.
  2. Re-organize current README and Front Page
  3. Add new contents to documentation
  4. Remove obsolete content from final documentation:
    • Wiki > Installation instructions > Binary packages
    • Wiki > Using Sun CC on Solaris
    • Wiki > Galleries and Examples

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant