Currently:
The project has quite some documentation, available in the docs folder. All the links to the files in there are in the README.md but navigation is not easy at all. Our documentation was written by the maintaining team, only the CLI configuration is generated when something in the CLI changes, by a github action.
Expected:
Find a way to generate and host a static site where the documentation would be easy to consult. This documentation has to be versioned since there are also documentation on the different options that exist.
Currently:
The project has quite some documentation, available in the
docsfolder. All the links to the files in there are in theREADME.mdbut navigation is not easy at all. Our documentation was written by the maintaining team, only the CLI configuration is generated when something in the CLI changes, by a github action.Expected:
Find a way to generate and host a static site where the documentation would be easy to consult. This documentation has to be versioned since there are also documentation on the different options that exist.