Browsing & Navigation
Navigate your generated wiki with the sidebar, table of contents, and page viewer.
Once a wiki is generated, you get a full documentation viewer with three panels: a topic sidebar, the main content area, and a table of contents.
Wiki Viewer Layout
The wiki viewer is split into three sections:
| Panel | Position | Purpose |
|---|---|---|
| Topic sidebar | Left (260px) | Hierarchical tree of all wiki topics and subtopics |
| Content area | Center | Rendered Markdown for the selected page |
| Table of contents | Right (200px) | Page headings with scroll-synced highlighting |
The table of contents panel is only visible on extra-large screens (XL+). On smaller screens, use the topic sidebar and page headings to navigate.
Topic Sidebar
The sidebar displays all wiki pages in a nested tree structure. Topics can have subtopics, and clicking any item loads that page in the content area.
- Nested hierarchy — Topics expand and collapse to show child pages
- Active page highlight — The currently viewed page is highlighted in the sidebar
- Persistent across navigation — Your expanded/collapsed state is preserved as you browse
Content Area
The main panel renders the wiki page as styled Markdown with support for:
- Headings (h1–h3) with auto-generated anchor IDs
- Code blocks with syntax highlighting and language labels
- Mermaid diagrams rendered inline for architecture and flow visualizations
- Tables, blockquotes, and lists with consistent styling
- Inline code with syntax-aware formatting
Source Files
At the bottom of each page, a collapsible Source Files section lists every file from the repository that was referenced when generating that page. This lets you jump from documentation back to the actual code.
Table of Contents
The right-side TOC lists all headings (h1–h3) on the current page. As you scroll, the active heading is highlighted automatically using an intersection observer. Click any heading to jump to that section.
Wiki List Page
The main /app/wiki page shows all your generated wikis in a card grid:
- Search — Filter wikis by name in real time
- Wiki cards — Each card shows the repository name, description, language, star count, and generation status
- Status indicators — See at a glance whether a wiki is completed, generating, or failed
- Quick access — Click any card to open the wiki viewer