Wiki Documentation
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:
- Type search terms
- Tree filters to matching pages
- Click result to navigate
- 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
- Click "Create Page" button in sidebar
- Enter page title
- Optionally add initial content
- Click Create
The page appears in the navigation tree at the root level.
New Subpage
- Hover over existing page in tree
- Click the "+" icon that appears
- Enter subpage title
- 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:
- Click "Edit Page" button in right sidebar
- Page content becomes editable
- Title can be modified
- 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:
- Click "Save" button
- Changes commit immediately
- Revision created automatically
- Page returns to view mode
Cancel Editing
To discard changes:
- Click "Cancel" button
- Confirm if significant edits made
- 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
- Click "Revision History" button in right sidebar
- Modal shows all revisions
- Each entry shows: date, author, changes
- Click revision to preview
Comparing Revisions
- Open revision history
- Select two revisions
- Click "Compare"
- Diff view highlights additions and deletions
Restoring Revisions
- Find desired revision in history
- Preview to confirm correct version
- Click "Restore"
- Content replaces current page
- 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
└── RetrospectivesPage 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:
| Role | Capabilities |
|---|---|
| Agency Owner | Full access: create, edit, delete |
| Manager | Full access: create, edit, delete |
| Developer | Create and edit own pages, view all |
| Client | View only if enabled |
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.
Create Wiki Page
Create new wiki pages to document knowledge, processes, and technical specifications. Pages can be root-level documents or nested subpages, supporting deep hierarchical organization for complex documentation needs.
Creating a Root Page
Root pages appear at the top level of your wiki tree.
From the Sidebar
- Click "Create Page" button at the top of the sidebar
- The create modal opens
- Enter page title in the required field
- Optionally add initial content
- Click Create
From Empty State
When wiki has no pages:
- See empty state message
- Click "Create your first page"
- Complete the creation modal
- Your first page is ready
Creating a Subpage
Subpages nest under existing pages, building hierarchical documentation.
From Page Tree
- Hover over the parent page in sidebar tree
- A "+" icon appears on the right
- Click the "+" icon
- Modal opens with parent context
- Enter subpage title
- Click Create
The new page nests under the parent in the navigation tree.
Parent Context
When creating a subpage, the modal shows:
- Parent page title
- Visual indicator of nesting
- Confirmation of hierarchy
This helps confirm you're creating at the correct location.
Modal Fields
Page Title (Required)
Purpose: The name that appears in navigation and as the page heading.
Guidelines:
- Descriptive and specific
- 3-100 characters
- Avoid special characters that may cause URL issues
- Use consistent naming conventions
Good examples:
- "API Authentication Guide"
- "Deploying to Production"
- "Sprint 23 Retrospective Notes"
Avoid:
- Single words like "Notes" (too generic)
- Very long titles (truncate in navigation)
- Duplicating existing page names
Initial Content (Optional)
Purpose: Start the page with content instead of blank.
Format: Plain text or Markdown-style formatting.
Use cases:
- Paste existing content
- Start from template
- Quick notes to expand later
If left blank, page creates empty—you can add content in edit mode after creation.
After Creation
Immediate Navigation
After clicking Create:
- Modal closes
- New page appears in tree
- Page content loads in center
- You can immediately start editing
Empty Page View
New pages with no initial content show:
- Page title as heading
- Empty content area
- Edit button to add content
Edit Mode
To add content after creation:
- Click "Edit Page" in right sidebar
- Page enters edit mode
- Add your content
- Click Save
Page Organization
Choosing Location
Before creating, decide hierarchy:
Root page when:
- Major documentation category
- Standalone reference
- Index or hub page
Subpage when:
- Related to existing page
- Part of larger topic
- Detailed expansion of parent
Restructuring Later
Pages can be moved after creation:
- Drag and drop in tree (if enabled)
- Edit page to change parent
- Create new page and copy content
Depth Considerations
While unlimited nesting is supported:
- 2-3 levels is typically sufficient
- Deep nesting makes navigation harder
- Use cross-links instead of deep trees
Templates
Creating Template Pages
Set up reusable templates:
- Create page named "[Template] Meeting Notes"
- Add structure with placeholders
- When needed, copy template content to new page
Template Suggestions
Meeting Notes:
## Date: [DATE]
## Attendees:
-
## Agenda
1.
## Discussion
## Decisions Made
## Action Items
- [ ]
## Next Meeting:Technical Spec:
## Overview
## Problem Statement
## Proposed Solution
## Technical Design
## API Changes
## Database Changes
## Testing Strategy
## Rollout PlanRunbook:
## Purpose
## Prerequisites
## Steps
1.
2.
3.
## Verification
## Rollback
## EscalationBest Practices
Name Consistently
Establish team conventions:
- "How to..." for guides
- "[Component] Architecture" for tech docs
- "YYYY-MM-DD Meeting" for notes
Start with Structure
Even with initial content empty:
- Plan your headings
- Know what sections needed
- Create outline first
Link on Creation
After creating:
- Link from related pages
- Add to index pages
- Reference in relevant tasks
Set Ownership
Every page should have an owner:
- Responsible for updates
- Answers questions
- Reviews periodically
Permissions
Page creation requires appropriate permissions:
| Role | Can Create Pages |
|---|---|
| Agency Owner | ✓ |
| Manager | ✓ |
| Developer | ✓ |
| Client | ✗ (typically) |
Project settings may further restrict creation.
Troubleshooting
Create button disabled:
- Title field may be empty
- Check required fields
- Verify permissions
Page not appearing in tree:
- Tree may need refresh
- Check for creation errors
- Try navigating away and back
Cannot create subpage:
- Parent page must be valid
- Check permissions
- Ensure parent isn't archived
Title already exists error:
- Page names should be unique within project
- Add specificity to title
- Check for existing similar page
Keyboard Shortcuts
| Action | Shortcut |
|---|---|
| Submit form | Cmd/Ctrl + Enter |
| Close modal | Escape |
| Focus title | Auto-focused on open |
Wiki Revision History
Every wiki page maintains complete version history. Each save creates a revision, allowing you to view past versions, compare changes, understand who modified what, and restore previous content if needed.
Understanding Revisions
What Is a Revision
A revision is a saved snapshot of a page at a specific moment:
- Content: Complete page text at save time
- Title: Page title (if changed)
- Author: Who made the change
- Timestamp: When saved
- Revision number: Sequential identifier
When Revisions Create
New revision created when:
- Page first created (revision 1)
- Edit mode saved with changes
- Restoration from older version
- Import or bulk update operations
Revision Retention
All revisions are preserved indefinitely:
- No automatic pruning
- Complete audit trail
- Storage optimized for text
Accessing Revision History
From Page View
- Select a wiki page
- Look at right sidebar
- Find "Revision History" button
- Shows revision count (e.g., "Revision History (12)")
- Click to open modal
Revision Modal
The modal displays:
- List of all revisions
- Newest first (descending order)
- Each entry shows: date, author, summary
- Navigation for long lists
Revision List
Entry Information
Each revision shows:
| Field | Description |
|---|---|
| Revision # | Sequential number |
| Date | When saved (relative or absolute) |
| Author | Who made the change |
| Preview | Snippet or change summary |
Identifying Changes
Revisions may indicate:
- "Page created" for first revision
- "Content updated" for edits
- "Title changed" if title modified
- "Restored from revision X" for restorations
Viewing a Revision
Preview Content
- Click any revision in list
- Preview panel shows content
- Read-only view of that version
- Full page content displayed
Comparing to Current
Preview clearly indicates:
- This is historical content
- Current version may differ
- Restore option available
Comparing Revisions
Opening Diff View
- In revision modal, select first revision
- Hold Ctrl/Cmd and select second revision
- Click "Compare" button
- Diff modal opens
Understanding Diffs
The comparison shows:
Added content: Highlighted in green Removed content: Highlighted in red Unchanged: Normal display
Line-by-Line View
Diff displays changes contextually:
- Added lines marked with +
- Removed lines marked with -
- Surrounding context for clarity
Character-Level Diffs
Within changed lines:
- Specific word changes highlighted
- Fine-grained modification tracking
- Easier to spot small edits
Restoring Revisions
When to Restore
Restoration useful when:
- Accidental deletion of content
- Previous version was better
- Undoing someone else's changes
- Recovering from mistakes
Restore Process
- Open revision history
- Select desired revision
- Preview to confirm correct version
- Click "Restore" button
- Confirm restoration
After Restoration
- Page content replaced with old version
- New revision created (restoration tracked)
- Original versions preserved
- Restoration author recorded
Restoration Is Reversible
Restoration creates a new revision, so:
- You can restore again
- Nothing permanently lost
- Full audit trail maintained
Auditing Changes
Who Changed What
Revision history answers:
- Who last edited this page?
- When did specific content appear?
- What did it look like before?
- How has it evolved?
Compliance Use
For regulated environments:
- Complete change history
- Author accountability
- Timestamp verification
- No deleted history
Team Accountability
Revisions help with:
- Training new editors
- Reviewing contributions
- Understanding documentation evolution
- Resolving conflicting edits
Best Practices
Meaningful Saves
Don't save empty or trivial changes:
- Complete logical units of work
- Avoid "fix typo" commits
- Group related changes
Regular Checkpoints
For long editing sessions:
- Save periodically
- Each save is a recovery point
- Better to have extra revisions
Review Before Restore
Before restoring old content:
- Preview the revision
- Check what might be lost
- Consider copy-paste instead
- Document why restoring
Clean Up Through Editing
Rather than restoring old versions:
- Edit current version to fix
- Keep accumulated improvements
- Selective rollback when needed
Limitations
No Partial Restore
Restoration replaces entire page:
- Cannot restore single paragraph
- Copy-paste for partial recovery
- Manual merge if needed
No Delete Revisions
Individual revisions cannot be deleted:
- Complete history preserved
- By design for audit purposes
- Contact support for edge cases
Large Revisions
Very large pages may:
- Take longer to diff
- Have truncated previews
- Still function correctly
Common Scenarios
Accidental Content Deletion
- Notice content is missing
- Open revision history
- Find last revision with content
- Preview to confirm
- Restore or copy-paste
Unwanted Edit by Team Member
- See change you disagree with
- Open revision history
- Find pre-change revision
- Discuss with team first
- Restore if agreed
Understanding Evolution
- New to the document
- Open revision history
- Browse through versions
- Understand how decisions evolved
- Get context for current state
Merge Conflict Resolution
When two people edited:
- See unexpected content
- Compare recent revisions
- Identify both contributions
- Manually merge best of both
- Save combined version
Troubleshooting
No revisions showing:
- New page has only one revision
- Check permissions to view history
- Try refreshing modal
Diff not working:
- Select exactly two revisions
- Check browser compatibility
- Very large pages may timeout
Restore fails:
- Check edit permissions
- Verify page isn't locked
- Network issues may interrupt
Old revision looks wrong:
- Format changes over time
- Content is accurate
- Rendering may differ
Permissions
Revision access follows page permissions:
| Role | View History | Restore |
|---|---|---|
| Agency Owner | ✓ | ✓ |
| Manager | ✓ | ✓ |
| Developer | ✓ | ✓ (own pages) |
| Client | ✓ (if view enabled) | ✗ |
Some environments may restrict history access.