WWikis

Reading Your Wiki

Navigate pages, follow diagrams, and use the On This Page TOC inside the wiki viewer.

Wiki viewer with sidebar, content area, and On This Page panelWiki viewer with sidebar, content area, and On This Page panel

The wiki viewer has three panels:

PanelLocationPurpose
SidebarLeftNavigate between pages and sections
ContentCenterRendered markdown with diagrams and code
On This PageRightJump to headings within the current page

The header

The header shows:

  • BreadcrumbWikis / owner / repo with links back to the dashboard
  • Branch badge — the branch this wiki was generated from
  • Commit hash — links to the exact commit on GitHub/GitLab
  • ↺ Refresh — re-generate the wiki (owner only)
  • Indexed timestamp — when the wiki was last generated

Pages are grouped into sections. Click a section header to collapse or expand it. The currently active page is highlighted.

On mobile, the sidebar collapses into a drawer. Tap the menu icon in the top-left to open it.

Page content

Wiki pages are rendered GitHub-flavoured Markdown with:

Syntax-highlighted code blocks

Every code block shows the language and a Copy button.

def generate_wiki(repo_url: str, branch: str = "main") -> str:
    """Kick off wiki generation and return the wiki_id."""
    ...

Mermaid diagrams

Architecture diagrams, sequence diagrams, and flowcharts are embedded as interactive SVGs:

graph LR
    A[Clone repo] --> B[Parse files]
    B --> C[Build index]
    C --> D[Generate pages]
    D --> E[Browsable wiki]

Links between wiki pages navigate within the viewer — no full page reload.

Tables

Capability tables and API references are rendered as styled HTML tables.

On This Page

The right-hand On This Page panel lists every heading on the current page. Click any entry to scroll directly to that section. The panel stays fixed as you scroll.

Click the share icon (↗) in the top-right corner of any page to copy a direct link. Shared-link recipients must be authenticated to view the wiki.

Keyboard navigation

KeyAction
Enter in Ask barSubmit question
Shift + EnterNew line in Ask bar
Clicking a sidebar itemNavigate to page
Clicking a TOC itemScroll to heading