Feature description
The documentation style across modules should be made consistent. This includes:
- Having a similar mkdocs configuration, e.g. with logo, dark/light mode, bibtex and other features
- Removing author/contributor tables completely
- A diataxis structure (tutorials, how-to, explanations, reference) as far as possible for each module
- A similar landing page + getting started
- Identical links to other modules
- Similar warning/info blocks
- Link from PROTEUS logo to homepage of proteus-framework.org
- Optional: having a small "Proteus Framework" section that includes the Proteus Framework and the module's individual role
- Maybe more (input welcome)
Note: some modules have, so far, insufficient documentation available to meaningfully implement the Diataxis structure (e.g. ZEPHYRUS)
Preferred solution
Each module will have to be updated individually. Here is a checklist:
The modules with (?) are julia-based and might not easily be converted to the same style.
Relevant people
@timlichtenberg @nichollsh
Feature description
The documentation style across modules should be made consistent. This includes:
Note: some modules have, so far, insufficient documentation available to meaningfully implement the Diataxis structure (e.g. ZEPHYRUS)
Preferred solution
Each module will have to be updated individually. Here is a checklist:
The modules with (?) are julia-based and might not easily be converted to the same style.
Relevant people
@timlichtenberg @nichollsh