Skip to content

update the wiki page for the new sidebar and diagrams #246

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SyedFahad7 merged 1 commit into from
Nov 12, 2026
Merged

update the wiki page for the new sidebar and diagrams #246

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion platform/wiki.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ import HostedMcpCard from '/snippets/hosted-mcp-card.mdx';
Open **Wiki** in the Console and choose a **Repository**.
</Step>
<Step title="Pick an article">
The **Articles** index lists every page. Use **Search pages** or **Find in the wiki** to jump to a topic.
The sidebar starts with **Overview**, then **Subsystems**, the main parts of the code, with each one's areas underneath. **Areas** that aren't part of a subsystem come next, production code first, then tests, vendored code, tooling, and docs. The **Glossary** comes last. Use **Search pages** to jump to a topic. Search covers subsystem pages and the glossary too.
</Step>
<Step title="Read">
Each article has **Key components**, diagrams you can expand, and **Relevant source files**. **On this page** lists its sections, and **Previous page** and **Next page** move through the wiki in order.
Expand All @@ -40,6 +40,12 @@ import HostedMcpCard from '/snippets/hosted-mcp-card.mdx';

Turn on **Reading mode** to hide the surrounding Console while you read.

### Diagrams

The **Overview** page has an architecture diagram of the repository. Click a box to open its page. If a diagram is bigger than its frame, drag it to see the rest, or expand it. The zoom and expand buttons sit under the diagram. On a phone, swipe sideways to pan and up or down to scroll the page.

A wiki built before subsystems were added keeps its older sidebar, grouped by folder.

## Confidence labels

| Label | Means |
Expand Down
Loading