[doc] Reorganize documentation navigation: 24 root menus -> 10 - #8908
Open
nvuillam wants to merge 4 commits into
Open
[doc] Reorganize documentation navigation: 24 root menus -> 10#8908nvuillam wants to merge 4 commits into
nvuillam wants to merge 4 commits into
Conversation
The mkdocs/Zensical navigation had grown to 24 root entries, making the sidebar hard to scan. Pages are now grouped into a handful of sections without moving or renaming any file, so all megalinter.io URLs are kept. New root structure: - Home - Quick Start - Getting Started (which version, assisted install, vs Super-Linter, FAQ) - Installation (Coding Agents / CI-CD Platforms / Local usage sub-menus) - Configuration (config-* pages + Flavors + Linter Plugins) - Linters (all supported, list of linters, removed, by category) - Reporting (Reporters + Observability + LLM Advisor) - About (articles, used by, badge, thanks, sponsoring, contribute, license, changelog) - Try OX Security ASPM build.py emits the generated flavors nav block one level deeper, since Flavors is now nested under Configuration. The language / format / tooling_format / other generated blocks keep their previous depth and are unchanged; all four regenerate byte-identically. Verified with a full `zensical build --clean`: 403 pages, no new warning.
nvuillam
requested review from
Kurt-von-Laven,
bdovaz and
echoix
as code owners
September 6, 2026 06:25
Contributor
✅
|
Replaces the previous grouping, which relied on two vague umbrella
sections ("Getting Started", "Reporting") and nested Installation three
levels deep. Every root entry is now a concrete, searchable noun and the
tree is at most two levels deep outside the generated linter/flavor lists.
Root structure:
- Home
- Quick Start
- Coding Agents (overview, Agent Skills, Agent Plugins)
- Installation (which version, assisted, 7 CI platforms, Docker CLI,
run locally, mega-linter-runner) - flat, no sub-menus
- Configuration (config-* pages, LLM Advisor + providers, Linter Plugins)
- Linters (supported, list, removed, 4 category trees)
- Flavors (all, custom, generated flavors, statistics)
- Reporters (17 reporters + Observability)
- About (FAQ, vs Super-Linter, articles, used by, badge, thanks,
sponsoring, contribute, license, changelog)
- Try OX Security ASPM
Flavors and Linters both sit back at root level, so build.py needs no
change: the flavors / language / format / tooling_format / other
generated blocks keep their original indentation and regenerate
byte-identically.
Also drops the "(beta)" label from the SARIF reporter in README.md,
docs/reporters.md and docs/reporters/SarifReporter.md.
nvuillam
changed the title
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The documentation navigation had grown to 24 root entries, making the left sidebar on https://megalinter.io long and hard to scan.
Solution
Group the existing pages into 10 root entries. No file is moved or renamed, so every
megalinter.io/<page>/URL stays valid — onlynav:inmkdocs.ymlchanges.Every root entry is a concrete, searchable noun (no umbrella sections like "Getting Started" or "Reporting"), and the tree is at most two levels deep outside the generated linter and flavor lists.
index.mdquick-start.mdconfig-*pages,LLM Advisor(advisor + 8 providers), Linter PluginsObservability(Grafana, Datadog, Elastic, New Relic)SARIF reporter is no longer "beta"
Dropped the
(beta)label from the SARIF reporter inREADME.md,docs/reporters.mdanddocs/reporters/SarifReporter.md.Build system
LintersandFlavorsboth stay at root level, so.automation/build.pyneeds no change: theflavors,language,format,tooling_formatandothergenerated nav blocks keep their original indentation.Verification
update_mkdocs_and_workflow_yml_with_flavors()andgenerate_mkdocs_yml()against the new file: all five generated blocks come back byte-identical, so the nextmake megalinter-buildproduces no churnmain: 0 pages removed, 0 pages addedzensical build --clean: 403 pages, 9 warnings — all pre-existing broken links inside markdown content (all_linters.md,mega-linter-vs-super-linter.md), none related to the navigation