TO DO DOCUMENTATION

This page gathers what is left to do for the documentation as well as ideas to improve it.

Feel free to add your thoughts!

Left to do

Is there a way to fix documentation on old releases without doing a patch release?
Check open PRs on github.io to see if anything should be transfered from it to readthedocs
Implement a GitHub action to check for dead links
Write guidelines for documentation contribution (create a glossary? links to external resources)
Add link in readthedocs to the "how to contribute" that stays on powsybl.org
Add link to release notes for each readthedocs + link to dependencies
Add link to the parent readthedoc site for each repo (by clicking on the powsybl logo)
Decide what to do about tutorials
Decide what to do about user stories
Add build-docs/ to .gitignore
Make sure the copyright is ok for each repo
Update sphinx version to 7.3.7 (or more)
Decide what to do about README in each repo
Clean powsybl.org
Make sure code on docs is up to date (jdocs test)
Homogenize project names
Add styles.css on all repositories
Add github logo (and link) on the footer