Use 'SUMMARY.md' to describe navigation structure by 'mkdocs-literate-nav' plugin
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 42/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- markdown
- Domain
- documentation
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.
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/.
- Dominant language
- CSS
- Stars
- 3.3k
- Forks
- 446
- PR merge metrics
- No merged PRs in 30d
Getting set up
We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.
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.
More from msys2/msys2.github.io
-
Mirror RegistrationOpen
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
msys2/msys2.github.io#445 · 17 comments ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
msys2/msys2.github.io#439 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
msys2/msys2.github.io#426 · 8 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
msys2/msys2.github.io#419 · 6 comments ·
-
Difficulty 4/5 3-5 days Newbie friendliness 38/100
msys2/msys2.github.io#411 ·
All issues in msys2/msys2.github.io
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Table: Space fires onActivate in single-selection mode — the reference doc and the JSDoc disagreeOpen
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
sidorares/react-x11-components#764 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 71/100
t4t5/omdrop-owl#14 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 1/5 Under an hour Newbie friendliness 91/100
githubnext/gh-aw-workshop#4458 ·
Maintainers usually reply within 1 day
-
bug:new
Difficulty 1/5 Under an hour Newbie friendliness 84/100
callstackincubator/simlock#451 ·
Maintainers usually reply within 1 day