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.

Sign up for GitHub

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

Jump to bottom

Generate static site for our documentation #217

Open
Lysoun opened this issue Oct 3, 2023 · 0 comments
Open

Generate static site for our documentation #217

Lysoun opened this issue Oct 3, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Lysoun
Copy link
Member

Lysoun commented Oct 3, 2023

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.
@Lysoun Lysoun added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Lysoun