KnowHub Documentation

Build a collaborative knowledge base with rich text editing and page linking

Creating Pages

New Page

Click "+ New Page" in KnowHub. Choose between:

  • Document: Standard text page with rich formatting
  • Whiteboard: Visual canvas for diagrams and sketches

Rich Text Editor

The editor supports:

  • Text formatting: Bold, italic, underline, colors
  • Headings: H1, H2, H3 for structure
  • Lists: Bulleted and numbered lists
  • Tables: Add and format tables
  • Code blocks: Syntax-highlighted code
  • Images: Upload and embed images
  • Links: Internal page links and external URLs
  • Task lists: Checkboxes for action items

Page Organization

Organize pages hierarchically:

  • Create parent pages and nest child pages underneath
  • Drag and drop to reorder pages in the sidebar
  • Use spaces to group related documentation
  • Add icons and colors to pages for easy identification

Page Linking

Internal Links

Type @ to mention and link to other pages. This creates a bidirectional link - both pages will show they're connected.

Link Test Cases & Tickets

Connect documentation to your work:

  • Link requirements pages to test cases
  • Connect architecture docs to related tickets
  • Reference user stories in feature specifications

Use the "Link Test Case" or "Link Ticket" buttons in the page toolbar.

Backlinks

View all pages that link to the current page in the sidebar. This helps discover related content and understand relationships.

Collaboration Features

Comments

Add comments to pages to:

  • Ask questions about content
  • Suggest improvements
  • Provide feedback on documentation
  • Discuss implementation details

Use @mention to notify specific team members.

Reactions

React to pages with emojis to show appreciation or flag for review. Quick way to gauge team sentiment about documentation.

Version History

View all changes made to a page, who made them, and when. Restore previous versions if needed.

Public Sharing

Share Pages Externally

Make pages public to share with external stakeholders:

  • Click "Share" and toggle "Public Access"
  • Get a shareable link that doesn't require login
  • Public pages are read-only for non-members
  • Revoke public access anytime

Use Cases

  • Share product roadmaps with customers
  • Publish release notes publicly
  • Provide documentation to external partners
  • Create a public knowledge base

Whiteboard Mode

Use whiteboard pages for:

  • Architecture diagrams and system design
  • User flow charts
  • Wireframes and mockups
  • Mind maps for brainstorming
  • Process flowcharts

Drawing tools include:

  • Shapes: rectangles, circles, arrows
  • Freehand drawing
  • Text boxes
  • Images
  • Sticky notes

Best Practices

  • Start with a documentation structure (spaces and pages)
  • Use templates for consistent formatting
  • Keep pages focused on a single topic
  • Link generously between related pages
  • Update documentation when features change
  • Encourage team members to contribute
  • Review and prune outdated documentation regularly
  • Use search to find and link existing content before creating new pages