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
At the moment, our documentation is quite split. For example, we want to keep the README minimal and should serve as a summary for this repository, like how it should be. However, we also have a CONTRIBUTING.md file and a Wiki. We need to draw a line, for instance:
Do we drop the Wiki entirely? Rigorous change though.
As of now on wiki homepage at the bottom there is link Getting started and section
Rarely user will get to this page in my view
maybe change wording For documentation. I believe in users eyes documentation is for dev's, gone is the age of terminal where user inserts floppy disc and really has to read documentation how to use software.
or make getting started actual link to getting started page in wiki
But I do not want to put a quick start in the README, as it's then hard to draw a line, sort of. The "Getting started" page is at the bottom, and I can't fix that, unless I customise the pages which take a bit of work.
maybe change wording For documentation. I believe in users eyes documentation is for dev's, gone is the age of terminal where user inserts floppy disc and really has to read documentation how to use software.
This I can understand. I have fixed that a short while ago, what do you think? Would it be more clear now? Because the README is short, users would easily see the Documentation header and thus how to get started.
Describe the documentation you want to change
At the moment, our documentation is quite split. For example, we want to keep the README minimal and should serve as a summary for this repository, like how it should be. However, we also have a
CONTRIBUTING.md
file and a Wiki. We need to draw a line, for instance:CONTRIBUTING.md
?Acknowledgements
The text was updated successfully, but these errors were encountered: