Overview

The Wiki provides a dedicated space for project documentation, knowledge sharing, and team resources. Create pages for technical specs, onboarding guides, process documentation, and any information your team needs to reference. Pages organize hierarchically with full revision history.

The Problem This Solves

Documentation scattered across tools creates chaos. Technical specs in Google Docs, meeting notes in Notion, API references in Confluence—your team wastes time searching instead of building.

Wiki centralizes project knowledge where work happens. Developers document alongside development. Context lives with code. New team members find answers without hunting through external tools.

What You Are Looking At

The Wiki interface uses a three-column layout:

Left Sidebar: Navigation tree showing all pages and subpages. Search field for finding content. "Create Page" button for new documentation.

Center Content: The selected page's content with title and body. Edit mode transforms this into a rich text editor.

Right Sidebar: Page metadata including author, creation date, last update, and access to revision history. Edit/Save/Cancel controls when you have edit permissions.

Navigation Tree

The left sidebar shows all wiki pages in hierarchical structure:

Page Organization

Pages organize in a tree structure:

• Root pages: Top-level documentation
• Subpages: Nested under parent pages
• Depth: Unlimited nesting levels

Click any page title to view its content in the center panel.

Pinned Pages

Important pages can be pinned to appear at the top of the navigation:

• Frequently referenced documents
• Onboarding materials
• Critical specifications

Pinned pages display in a separate "Pinned" section above the main tree.

Search

The search field filters pages by title and content:

1. Type search terms
2. Tree filters to matching pages
3. Click result to navigate
4. Clear search to show all pages

For deeper search, use the Search button in the page header to open the full search modal.

Creating Pages

New Root Page

1. Click "Create Page" button in sidebar
2. Enter page title
3. Optionally add initial content
4. Click Create

The page appears in the navigation tree at the root level.

New Subpage

1. Hover over existing page in tree
2. Click the "+" icon that appears
3. Enter subpage title
4. Click Create

The subpage nests under its parent in the tree.

See Create Wiki Page for detailed creation options.

Editing Pages

Enter Edit Mode

With a page selected:

1. Click "Edit Page" button in right sidebar
2. Page content becomes editable
3. Title can be modified
4. Content area shows rich text editor

Rich Text Editor

The editor supports:

Text formatting:

• Bold, italic, underline
• Headings (H1-H6)
• Ordered and unordered lists
• Code blocks

Rich content:

• Links to external resources
• Links to other wiki pages
• Images (upload or URL)
• Tables

Structure:

• Horizontal dividers
• Block quotes
• Nested lists

Saving Changes

After editing:

1. Click "Save" button
2. Changes commit immediately
3. Revision created automatically
4. Page returns to view mode

Cancel Editing

To discard changes:

1. Click "Cancel" button
2. Confirm if significant edits made
3. Page returns to previous content

Page Information

The right sidebar shows metadata for the selected page:

Author: Who created the page with avatar and name

Created: Original creation date

Updated: Last modification date

Revisions: Count of saved versions with link to history

Revision History

Every save creates a new revision, enabling:

• View past versions
• Compare changes between revisions
• Restore previous content
• Track who changed what and when

Viewing Revisions

1. Click "Revision History" button in right sidebar
2. Modal shows all revisions
3. Each entry shows: date, author, changes
4. Click revision to preview

Comparing Revisions

1. Open revision history
2. Select two revisions
3. Click "Compare"
4. Diff view highlights additions and deletions

Restoring Revisions

1. Find desired revision in history
2. Preview to confirm correct version
3. Click "Restore"
4. Content replaces current page
5. New revision created (restoration tracked)

See Wiki Revisions for detailed history management.

Organizing Documentation

Hierarchy Best Practices

Top-level categories:

Wiki/
├── Getting Started/
│   ├── Onboarding
│   ├── Development Setup
│   └── Team Processes
├── Technical Docs/
│   ├── Architecture
│   ├── API Reference
│   └── Database Schema
├── Processes/
│   ├── Code Review
│   ├── Deployment
│   └── Incident Response
└── Meeting Notes/
    ├── Sprint Planning
    └── Retrospectives

Page Naming

Good names:

• Descriptive and specific
• Action-oriented when applicable
• Consistent style across wiki

Examples:

• "API Authentication Guide" (not "Auth")
• "Deploying to Production" (not "Deploy")
• "Q4 2024 Roadmap" (not "Roadmap")

Cross-Linking

Link between pages to create navigable documentation:

• Reference related pages inline
• Create index pages listing subtopics
• Link from specs to implementation guides

Searching Wiki

Quick Search

The sidebar search filters visible pages:

• Type to filter
• Matches page titles
• Quick navigation

Full Search

Click the Search button in the header for comprehensive search:

• Searches page content
• Shows snippets with matches
• Ranks by relevance
• Filters by date or author

See Wiki Search for advanced search features.

Common Wiki Patterns

Onboarding Documentation

Pages to include:

• Welcome and team overview
• Development environment setup
• Codebase architecture
• Team processes and conventions
• Tool access and accounts

Technical Specifications

Structure:

• Overview and goals
• Requirements
• Design decisions
• API contracts
• Edge cases
• Testing approach

Meeting Notes

Template:

• Date and attendees
• Agenda items
• Decisions made
• Action items with owners
• Next meeting date

Runbooks

For operations:

• Step-by-step procedures
• Troubleshooting guides
• Escalation paths
• Contact information

Permissions

Wiki access follows project permissions:

Page deletion may be restricted to owners and managers.

Best Practices

Keep Documentation Current

• Update docs when code changes
• Review documentation quarterly
• Mark outdated content clearly
• Assign documentation owners

Write for Your Audience

• New team members need context
• External stakeholders need summaries
• Technical docs need precision
• Runbooks need clarity under pressure

Use Templates

Create template pages for common types:

• Copy template to new page
• Fill in specifics
• Consistent structure aids findability

Link Liberally

• Connect related pages
• Reference from task descriptions
• Create breadcrumb trails
• Build a knowledge graph

Troubleshooting

Cannot create page:

• Verify project permissions
• Check page title isn't blank
• Ensure stable network connection

Edit mode not appearing:

• Confirm you have edit permissions
• Check if page is locked
• Try refreshing the page

Revisions not showing:

• Page needs at least one save after creation
• Check revision history button
• Revisions may take moment to load

Search not finding content:

• Search may not index immediately
• Try different keywords
• Check spelling

Images not displaying:

• Verify image URL is accessible
• Check image format (PNG, JPG, GIF)
• Uploaded images may take moment to process

How to Report a Problem or Request a Feature

Your feedback matters. Here is how to share it:

If wiki behaves unexpectedly or you need additional features, we want to know.

In the Sidebar, click on Support Tickets and open a ticket for the problem. Everything is interactive and fast through the GitScrum Studio platform.