e-pettersson-ericsson
commented
4 years ago Since the documentation has been moved from GitHub pages to markdown files on master it is considerably easier to find what one is looking for. I'm closing this issue.
Description
As a user (and new developer) it is not super easy to find the documentation about REMReM that exists on GitHub pages. Only one link to GitHub pages exists from the source code repository - but there is no navigation menu or easy-to-skim-through tree structure of the existing documentation there.
Motivation
To make it easier for users and developers finding the information they are looking for we need to make the documentation more visible and easier to find.
Exemplification
The README.md is the first thing you see when you navigate to the source code repository and naturally is the first place to start looking for guides/tutorials etc. I propose to extend the Documentation links there to include links to all existing documentation (and structure it in a way so it's easy to find what you're looking for).
The link pointing to REMReM generate main documentation is broken - and it should point to https://eiffel-community.github.io/eiffel-remrem-generate/ and the remaining list of links could be extended.
Perhaps something like this? REMReM generate documentation
A change to markdown format would also be easier to maintain :)
Benefits
More visible documentation. Users will be able to find what they are looking for themselves without having to find the right people to contact first, and they can get stared right away with using REMReM. If the documentation switch from HTML to markdown it will be easier to maintain.
Possible Drawbacks
None.