Use 'SUMMARY.md' to describe navigation structure by 'mkdocs-literate-nav' plugin
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 3.3k
- Forks
- 446
- Avg merge
- 2h 16m
- Merged PRs (30d)
- 1
Description
Suggestion
I suggest that msys2.github.io use SUMMARY.md to describe its navigation structure by mkdocs-literate-nav plugin, instead of configuring it through the nav field in mkdocs.yml.
By doing this, contributors who want to edit documentation or modify its navigation structure would only need to focus on docs_dir, which is web/.
Contributor guide
No contributing guide indexed for this repository
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
Start by reviewing mkdocs.yml and the web/ documentation directory, then read the mkdocs-literate-nav plugin documentation. Done means navigation is described by a SUMMARY.md in web/ instead of the nav field, and the documentation site still builds with the intended structure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100