DesignSafe-CI / DesignSafe-CI/DS-User-Guide
Make Navigation Easier to Manage
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Tcl
- Stars
- 1
- Forks
- 27
- PR merge metrics
- No merged PRs in 30d
Description
Idea
Control navigation per directory via mkdocs-awesome-pages-plugin.
Use Cases
- So adding new content within a directory is more like adding new content via standard root config.
- So adding new content within a directory does not require editing
navinmkdocs.yml. - (Maybe) So cards on Use Cases Overview can link to individual overview pages without repeating content.
Related
- requires https://github.com/TACC/TACC-Docs/issues/60 [^1]
[^1]: Why? Because DS-User-Guide features come via TACC-Docs.[^2]
[^2]: Sounds dumb… Stop that? I agree. See TACC/TACC-Docs#53.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the mkdocs-awesome-pages-plugin navigation documentation and inspect user-guide/mkdocs.yml, especially the nav section around lines 112-136. Compare it with the use-case README links to understand the current content workflow, then check TACC/TACC-Docs#60 and #53 before defining what a completed navigation setup should support.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100