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 --> create readthedocs for 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
Rework the getting started
Documentation in https://javadoc.io/doc/com.powsybl/powsybl-core/latest/com/powsybl/iidm/network/VoltageLevel.html to remove from Javadoc and include in readthedocs (~~+ fix errors in graph: 5 -- 6 should be in dashed lines and 8-4 should be replaced by 8-7~~)
Add artifacts description (automatically grabbed from pom files) in each readthedocs
Add readthedocs for powsybl-tutorials and link powsybl.org to this new readthedocs