Wiki

Create and manage project documentation directly from your code editor. Browse hierarchical pages, edit with Markdown, track revisions, and search across your entire knowledge base.

The Problem This Solves

Project documentation lives in one tool, code lives in another. When you need to reference API specs, architecture decisions, or setup guides, you switch to a browser, find the wiki page, read it, then switch back. Each context switch interrupts your flow.

GitScrum Studio puts the wiki inside an editor panel. Reference documentation while coding, update it as you implement, and never leave your development environment.

What You Are Looking At

Click Wiki under the Knowledge section in the sidebar tree. The panel opens with a tree navigation on the left and a content area on the right.

Page Tree

The left side shows all wiki pages organized in a hierarchy. Pages can contain child pages, creating nested structures for organized documentation:

Getting Started
  ├─ Installation Guide
  ├─ Configuration
  └─ Deployment
API Reference
  ├─ Authentication
  ├─ Endpoints
  └─ Error Codes
Architecture
  └─ Database Schema

Expand and collapse parent pages to navigate the tree. Click any page to load its content in the right panel.

Content Area

The right side displays the selected page's content. At the top, you see the page title and breadcrumb navigation showing the page's position in the hierarchy.

Creating Pages

Click the create button in the panel header to open the new page form:

Leave the parent field empty to create a root-level page. Select an existing page as parent to create a nested child page.

Editing Pages

Click the edit button on any page to switch to edit mode. The content area transforms into an editor where you can modify:

• Title — The page heading
• Content — Full Markdown editing with standard formatting

Save your changes or cancel to revert. Edits are saved to the server immediately.

Revision History

Every edit creates a revision. Click the revisions button to view the page's change history:

Restoring Previous Versions

You can restore any previous revision. This creates a new revision that reverts the content to the selected version. The previous content is preserved in history — nothing is permanently lost.

Deleting Pages

Click the delete button on a page to remove it. A confirmation dialog appears before deletion. Deleting a parent page may affect child pages — review the hierarchy carefully before confirming.

Search

Use the search field at the top of the wiki panel to filter pages. The search runs across page titles and matches results in real-time as you type.

Pro Tips (Once You Are Comfortable)

• Split view with code. Open the wiki panel alongside your code files. Reference API documentation or architecture guides while implementing.

• Use nesting for structure. Organize pages by module, feature, or team. Deep hierarchies are easier to navigate than flat lists of pages.

• Document as you code. When you implement a complex algorithm or configure a tricky integration, update the wiki immediately. It takes 30 seconds while the context is fresh vs. 30 minutes later when you have forgotten the details.

• Check revisions before editing. If a teammate recently updated a page, review their changes to avoid overwriting their work.

Permissions

The extension respects your GitScrum account permissions:

• Agency Owners and Managers: Full CRUD access to all wiki pages
• Developers: Can create, edit, and view wiki pages in assigned projects
• Clients: View-only access to wiki pages (if granted project access)

How to Report a Problem or Request a Feature

If wiki pages do not load, changes fail to save, or the revision history appears incomplete, open a support ticket in the GitScrum web application. Navigate to Support Tickets in the sidebar and describe the issue. Include the extension version and editor details.