Repository navigation
update the wiki page for the new sidebar and diagrams - #246
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
There was a problem hiding this comment.
Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota. Try requesting a review at a lower effort level.
An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.
There was a problem hiding this comment.
Graphify reviewed this change.
No issues found by static checks — no coupling regressions or blocking issues in the code graph. That is not the same as safe to merge: see what was not checked.
Not checked: tests were not run; no formal proof of the changed code.
Graphify review — findings
Updates the article-picking step so the sidebar now opens with Overview, then Subsystems and their areas, followed by standalone areas, Glossary, and search that covers subsystems plus glossary entries. Adds a Diagrams section that shows the Overview architecture diagram, lets users click boxes to open pages, drag or expand oversized diagrams, and use zoom controls, with swipe panning on phones. Wikis built before subsystems retain their older folder-grouped sidebar.
No blocking issues surfaced.
Analysis details — impact, health, verification
Impact & health
Graphify review
Impact — 12 functions depend on the 12 functions this change touches.
Health — grade A; no new coupling hotspots.
Verification — 12 functions in the blast radius were not formally verified this run (proofs are advisory here).
Gate & verification
graphify gate
PASS — objectively clean (no health regressions, tests not run — proofs not run this pass (advisory)). Grounded, not self-assessed.
Advisory (not blocking):
- verification_scope: 12 function(s) in the blast radius were not formally verified this run
The wiki sidebar now starts with Overview, then Subsystems with their areas underneath, then the remaining areas, and the Glossary last. Search also finds subsystem pages and the glossary. The page still described a flat Articles index.
This updates the reading steps to match. It also adds a short note on the Overview diagram: click a box to open it, drag to see the rest when it's bigger than its frame, and use the zoom and expand buttons under it. Older wikis keep the folder sidebar, and the page says so.