Actions
Documentation #7396
openuserguide: standardize rst formatting for chapters
Affected Versions:
Effort:
Difficulty:
Label:
Description
Ensure that throughout our documentation, we use the same markdown conventions for
- Chapters
- Sections
- Subsections
I think this may make help with building the docs (in terms of the references built),
but also adding new sections, as there could potentially be less conflicts nor fidgeting
when trying to add those ("what to use?" "Will this create a 'subsection' or a 'supersection'?")
Some possibly useful references:
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections
https://lpn-doc-sphinx-primer.readthedocs.io/en/stable/concepts/heading.html
Actions