nesi / support-docs

NeSI Mkdocs based support pages.
https://docs.nesi.org.nz/
4 stars 5 forks source link

Adding docs to clarify how Supported Applications and Module List files in this repository are managed and updated #361

Closed ndjones closed 3 days ago

ndjones commented 1 week ago

Describe the documentation you'd like There is good documentation of how these parts of the docs are updated in CONTRIBUTING.md. Would it be possible to use comments in the code to point to these instructions, or otherwise to leave some breadcrumbs so its easy to trace these dependencies?

Justification Looking at how to update when moving from the published docs.nesi.org.nz support applications page using the edit button lands at a dead end. could be useful to link back to the modules list page and the CONTRIBUTING.md docs to clarify how to approach updates.