Knowledge Base

Nexus — Docs & Knowledge Base

Build a living team wiki with spaces, page templates and ADRs, rich-text documents, whiteboards, bidirectional links, status and approval workflows, full traceability to your engineering work, and one-click public sharing — all searchable from your phone via Telegram or WhatsApp.

12 min read

Spaces & Structure

KnowHub is organised into Spaces — top-level containers that group related pages together. Think of a Space as a department or project area, with pages nested beneath it.

  • Create a Space by clicking + New Space in the KnowHub sidebar. Give it a name and an optional icon.
  • Typical spaces: Engineering, Product, QA, Design, Onboarding.
  • Each Space has its own page tree — pages and sub-pages are visible only under their parent Space.
  • Spaces can be set to private (members only) or shared with the whole project.
Start with 3–5 Spaces and resist creating more until you have content that clearly belongs somewhere new. A sparse, well-named structure beats a sprawling one every time.

Creating Pages

Inside a Space, click + New Page to create a page. Choose a page type and give it a title — the editor opens immediately.

FieldDescription
DocumentFull rich-text page with headings, tables, code blocks, images, callouts, and task lists. The go-to type for specs, runbooks, meeting notes, and process docs.
WhiteboardVisual canvas for diagrams, wireframes, flowcharts, and mind maps. Drag, draw, and annotate freehand.

Organising pages

  • Create a child (sub-page) by right-clicking any page in the sidebar and choosing Add subpage.
  • Drag and drop pages in the sidebar to reorder or nest them under a different parent.
  • Add an emoji icon and a cover colour to each page for quick visual identification in long lists.
  • Use top-level pages inside a Space as index pages — list what lives beneath with short descriptions.

Templates & ADRs

Rather than starting from a blank page, choose Page from template in the space menu to pre-fill a document with the right headings for its purpose.

Document types

  • Technical Specification, API Documentation, Meeting Notes, Product Requirements (PRD), SOP, Release Notes, Project Documentation, Incident Report.
  • Each template ships with real section headings, not empty placeholders — fill in the blanks instead of designing a structure from scratch.

Architecture Decision Records (ADR)

A dedicated ADR template follows the standard Decision → Context → Options Considered → Final Decision → Consequences flow. Link an ADR to the Features, Stories, Tasks, and Releases it affects using the same linking tools covered below, so anyone revisiting a past decision can see exactly what shipped as a result of it.

Technical documentation structure

  • Predefined templates for the categories every engineering team needs: Architecture, API Reference, Database Schema, Infrastructure, Security, Deployment, Development Guide, Testing Strategy, and Troubleshooting Guide.
  • Use these to keep technical documentation consistent across teams instead of everyone inventing their own outline.

Rich Text Editor

KnowHub uses a block-based editor (powered by ProseMirror). Every paragraph, heading, or table is its own block. Type / anywhere on an empty line to open the block insertion menu.

Supported block types

Headings H1–H3

Page title (H1), major sections (H2), subsections (H3).

Bulleted & numbered lists

Nest up to four levels deep with Tab / Shift+Tab.

Tables

Insert rows and columns, merge cells, and format headers.

Code blocks

Syntax highlighting for 40+ languages with a one-click copy button.

Images & attachments

Drag-and-drop upload or paste from clipboard. Resize images inline.

Task lists

Checkbox items — ideal for action items inside meeting notes.

Callout blocks

Info, warning, and success callouts with prominent icons.

Page embeds

Embed another Nexus page inline. Changes to the source page propagate everywhere it is embedded.

Task actions

Type /task to drop in an assignable action item with a due date. Click Convert to ticket and it becomes a real, trackable ticket on your board — no copy-pasting into the project board required.

Inline formatting

  • Bold, italic, underline, strikethrough, and inline code.
  • Text colour and highlight colour for callouts and emphasis.
  • Hyperlinks — paste any URL or type [[ to link to another KnowHub page.
  • Mention a teammate with @ to notify them instantly and link to their profile.

Table of contents

Every page's right-hand panel includes an auto-generated Table of Contents, built from your headings. Click any entry to jump straight to that section — handy on long technical specs and runbooks.

Page content is stored as structured JSON, which means the Telegram and WhatsApp AI assistants can read, search, and summarise your Nexus pages accurately when you use the /search or /ask commands.

Page Linking

Linking to other KnowHub pages

Type [[ inside the editor to open the page picker. Start typing the page name and select it to insert an inline link.

  • Links are bidirectional — both pages show each other in their Backlinks panel.
  • Hover over a link to preview the target page without navigating away.
  • Broken links (where the target page has been deleted) are highlighted in red.

Linking to tickets and test cases

  • Click Link in the page toolbar and choose Ticket or Test Case.
  • Search by ID or title. Multiple items can be linked to a single page.
  • Linked tickets and test cases appear in the page's right-hand panel, and the page appears in their detail sidebar — a full bidirectional trace from requirement to code to test.

Backlinks panel

Every page has a Backlinks tab in the right-hand panel showing every page, ticket, or test case that references it. Use this to understand impact before editing a specification — if ten test cases link to a requirements page, changing the requirement means reviewing those ten tests.

Document dependencies

Backlinks are automatic — Dependencies are explicit. Use the Dependencies tab to declare that one document depends on another (for example, an Authentication Architecture page depending on a Security SOP), so the relationship is visible even when the two pages never mention each other inline.

Status & Approval Workflow

Every page carries a status so your team can tell at a glance whether a document is safe to rely on.

FieldDescription
DraftWork in progress. Visible to the team, not yet vetted.
In ReviewSent to one or more reviewers for feedback before publishing.
PublishedReviewed and current — the version people should trust and link to.
DeprecatedSuperseded by a newer document, kept for historical reference.
ArchivedNo longer relevant. Hidden from normal browsing and search.

Reviewers and approval

  • Assign one or more reviewers to a page from the Properties panel.
  • Each reviewer approves, requests changes, or rejects — with an optional comment.
  • Turn on Require approval for a page and it cannot move to Published until every assigned reviewer has approved. Attempting to publish early tells you exactly who is still pending.
  • Every decision is kept permanently in the page's approval history, even after reviewers are reassigned.
Turn on Require approval for anything customers, auditors, or new hires will rely on — security policies, onboarding runbooks, incident postmortems. Leave it off for fast-moving internal notes where review would only slow things down.

Ownership & Review Reminders

Document ownership

  • Every page can have an Owner and a Backup Owner — the people accountable for keeping it accurate.
  • Set a Team responsible for broader accountability beyond a single person.
  • Owner, backup owner, and team are all set from the Properties panel and shown alongside the page's status, version, and dates.

Review reminders

Set a review interval — for example, "review this document every 90 days" — and Nexus keeps track of it automatically.

  • Once the interval elapses without the owner marking the page reviewed, it's automatically flagged as outdated.
  • The owner gets notified that a review is due.
  • Click Mark as reviewed now on any page to reset the clock the moment you've confirmed it's still accurate.
An outdated flag doesn't hide a page — it's a nudge, not a lock. Treat a growing pile of outdated documents as a signal to schedule a documentation cleanup pass.

Traceability & Impact

This is the feature that sets Nexus apart from a generic wiki: every document can show exactly what software work it drives.

Document → work traceability

A page's Impact panel shows the full chain — Documentation → Feature → Stories → Tasks → Test Cases → Release — so anyone reading a technical specification can immediately see what was built from it, not just what was written about it.

Impact analysis

Before editing a specification, check its Impact panel for a summary like "Linked to 3 Features, 14 Stories, and 27 Tasks." If any linked work belongs to a release, that release is called out too — so you know exactly how much work is potentially affected before you change a word.

Release Documentation

Use the Release Notes template and attach it to a real release, and Nexus organizes the page around that release automatically.

  • What's new, features, and changes — pulled from the tickets linked to that release.
  • Known issues and migration instructions, written directly into the page.
  • Related documentation — other Nexus pages linked to the same release.
  • Related test cases — the QA coverage tied to that release's tickets.
Pair a release-notes page with the ADR template for any major decisions that shipped in that release — future readers get both the "what changed" and the "why" in one place.

Collaboration

Comments

  • Click the comment bubble at the top of any page to open the threaded comment panel.
  • @mention a teammate to notify them in-app — they can reply directly in the thread.
  • Resolve comments to archive the thread without deleting it. Resolved threads remain accessible in the history.
  • Highlight any sentence in the editor and choose Comment on selection to anchor feedback directly to that exact text — e.g. "The API timeout should be 30 seconds" — instead of a generic page-level note.

Emoji reactions

Hover over the page header and click the reaction button to add an emoji. Reactions act as a lightweight approval signal — a thumbs-up from a tech lead can indicate the spec is approved for development without a formal comment thread.

Version history

  • Every save creates a version snapshot automatically — nothing to configure.
  • Open Version History from the page's ⋮ menu to browse all snapshots by date and author.
  • Click any version to preview the exact content at that point in time.
  • Click Restore to revert — the current version is preserved as a new snapshot, so nothing is permanently lost.
Version history is invaluable during incidents or compliance reviews. It lets you prove precisely what a specification said at any point in time — critical if a feature shipped with an undocumented behavioural change.

Activity timeline

Every page has an Activity tab showing exactly what happened to it, in order — who created it, who commented, who edited which section, who approved it, and when each version was published or restored. A single feed answers "what changed here, and who touched it" without digging through comments and version history separately.

Public Sharing

Any KnowHub page can be made publicly readable without requiring the viewer to log in. Useful for sharing docs with external stakeholders, partners, or customers.

  • Click Share in the page toolbar and toggle Public Access on.
  • Copy the shareable link and send it to anyone — no Everia account required to view.
  • Public pages are read-only. Visitors cannot edit or comment.
  • Toggle Public Access off at any time to revoke access. Existing links stop working immediately.

Common use cases

Share a product roadmap with customers or investors
Publish release notes or changelogs externally
Provide integration documentation to third-party partners
Create a public-facing support knowledge base
Before toggling public access, check that the page does not contain internal pricing, credentials, API keys, or unreleased feature details. There is no separate staging environment — toggling makes the page live immediately.

Best Practices

One page, one topic

Pages covering multiple topics are hard to link precisely and hard to find in search. Split aggressively — short focused pages beat long mixed ones.

Create a template page for recurring formats

Meeting notes, RFCs, runbooks, and post-mortems follow a pattern. Create one polished template page and duplicate it when needed.

Search before you write

Before creating a new page, search for existing content. Link to it rather than duplicating it. Duplication breeds inconsistency.

Update specs the same day features change

Stale documentation is worse than none — it misleads future readers. Make updating the relevant KnowHub page part of the definition of done.

Encourage contributions from everyone

Documentation is a team responsibility. Set the norm that anyone who discovers a gap writes the page. The author does not have to be an expert — clarity beats perfection.

Audit the wiki quarterly

Mark pages older than six months for review. Delete content that no longer applies. A lean, accurate wiki is far more useful than a large, stale one.

Ready to try it yourself?

Start free — no credit card required. GDPR compliant.