Skip to content

Wiki Mode

Wiki mode transforms a project's pages into a structured knowledge base with dedicated sidebar navigation, an auto-generated table of contents, and enhanced search. While regular pages are flexible and loosely organized, wiki mode imposes a more structured approach designed for long-lived, team-wide documentation.

Wiki vs. regular pages

AspectRegular pagesWiki mode
OrganizationFlat list with optional nestingTree-based structure with explicit hierarchy
NavigationSidebar list, breadcrumbsDedicated wiki sidebar with expandable tree
Table of contentsNot generatedAuto-generated from headings within each page
SearchStandard page searchEnhanced wiki search across all wiki pages
Intended lifespanNotes, drafts, temporary docsPersistent reference documentation
EditingAny project member (based on access)Any project member (based on access)
PublishingPer-page publishingPer-page publishing

Enabling wiki mode

Wiki mode is enabled at the project level.

  1. Open the project Settings.
  2. Navigate to the Features section.
  3. Find the Wiki toggle and enable it.
  4. A new Wiki section appears in the project sidebar.

TIP

Enabling wiki mode does not affect existing regular pages. You can use both regular pages and wiki pages within the same project. They are separate collections.

Creating wiki pages

Once wiki mode is enabled:

  1. Click the Wiki section in the project sidebar.
  2. Click New Page at the top of the wiki sidebar.
  3. Enter a title and begin writing.
  4. The page is automatically added to the wiki tree.

Creating child pages in the wiki

  1. Hover over an existing wiki page in the sidebar.
  2. Click the + icon to add a child page.
  3. The new page appears nested under the parent in the wiki tree.

Child pages work identically to Nested Pages — they support drag-and-drop reordering, moving between parents, and breadcrumb navigation.

Wiki structure

The wiki sidebar displays all wiki pages in a tree format:

Wiki
├── Getting Started
│   ├── Installation
│   ├── Configuration
│   └── First Steps
├── Architecture
│   ├── Backend
│   ├── Frontend
│   └── Database
├── Processes
│   ├── Release Process
│   ├── Code Review
│   └── On-call Rotation
└── FAQ

Structuring your wiki

A well-structured wiki follows these principles:

PrincipleGuideline
Top-level sectionsRepresent major areas (e.g., Getting Started, Architecture, Processes)
Second levelRepresent specific topics within each area
Third level and deeperUse sparingly for detailed sub-topics
NamingUse clear, descriptive page titles that stand on their own
OrderingPlace the most-accessed pages near the top of each section

Wiki navigation

The wiki sidebar provides persistent navigation:

  • Click a page to open it.
  • Click the arrow to expand or collapse child pages.
  • The current page is highlighted.
  • The tree state (expanded/collapsed) persists across sessions.

Table of contents

Each wiki page automatically generates a table of contents from its headings. The table of contents appears on the right side of the page when viewing and provides jump links to each section.

Heading levelIncluded in TOC
H1Yes
H2Yes
H3Yes
H4Yes (indented)
H5No
H6No

Breadcrumb navigation appears at the top of each wiki page:

Project > Wiki > Architecture > Backend

Each segment is clickable for direct navigation.

The wiki search bar at the top of the wiki sidebar searches across all wiki pages.

  1. Click the search icon or press / while the wiki sidebar is focused.
  2. Type your query.
  3. Results show matching page titles and content snippets.
  4. Click a result to open the page.

Wiki search indexes:

  • Page titles
  • Page body content
  • Heading text

TIP

For workspace-wide search that includes wiki pages, work items, and more, use the global search (Ctrl+K / Cmd+K).

Managing wiki pages

Reorder pages

Drag and drop pages in the wiki sidebar to change their order. The order is shared across all project members.

Move pages

Right-click a wiki page and select Move to to change its parent or move it to the wiki root level.

Archive wiki pages

Pages that are outdated but worth preserving can be archived. Archived wiki pages are hidden from the sidebar but can be restored from the archive view.

Delete wiki pages

Right-click a wiki page and select Delete to permanently remove it. If the page has children, you will be prompted to delete the children or move them up one level.

WARNING

Deleting a wiki page is permanent. Consider archiving instead if the content may be useful in the future.

Use cases

Team onboarding guide

Build an onboarding wiki with sections for each team:

  • Company overview and values
  • Development environment setup
  • Key tools and access
  • Team-specific processes
  • FAQ for new hires

Engineering knowledge base

Document technical decisions and architecture:

  • System architecture diagrams
  • API documentation
  • Database schemas
  • Deployment processes
  • Incident response procedures

Process documentation

Standardize team processes:

  • Sprint planning guide
  • Code review checklist
  • Release process
  • On-call handbook
  • Design review workflow

Product documentation

Maintain internal product reference:

  • Feature specifications
  • User research findings
  • Product roadmap notes
  • Competitive analysis

Best practices

  • Assign wiki owners — designate one or two people responsible for wiki structure and quality.
  • Review regularly — schedule quarterly reviews to archive stale content and update outdated pages.
  • Use templates — create templates for common page types (e.g., ADR template, runbook template). See Page Templates.
  • Link between wiki pages — cross-reference related topics to help readers discover relevant content.
  • Start small — begin with the most critical documentation and expand as the team contributes.