Wiki & Knowledge Base
Klority's Wiki isn't just an isolated file repositoryβit is a **connected knowledge hub** tied directly to your development lifecycle. By linking technical requirements, architecture specs, and meeting notes to active tasks and QA test cases, you keep documentation fresh and actionable.
Hierarchical Page Tree
Organize your documentation with an infinitely nestable, collapsible page hierarchy.
- Nestable Structure: Create parent/child page relationships recursively to design clean, logical spaces for your team.
- Drag-and-Drop Organization: Reorder or move pages within the tree instantly to restructure folders as your project evolves.
- Quick Search: Find pages by title or content instantly using the command palette (Cmd + K).
Block-Based Rich Editor (TipTap)
Klority implements a beautiful, block-based editing experience powered by TipTap, optimized specifically for engineering teams:
- π» Syntax-Highlighted Code: Embedded code blocks with native syntax highlighting for dozens of programming languages.
- π Interactive Tables: Create, resize, and edit inline tables for API specs, databases, and schemas.
- πΌοΈ Media & Asset Uploads: Drag and drop mockups, wireframes, and design files directly into the editor canvas.
- π Bidirectional Mentions: Mention and link tasks, users, test cases, or other wiki pages inline using `@` and `#` autocomplete.
Interactive Mermaid.js Diagrams
Document complex software architectures, workflows, and database relationships using inline **Mermaid.js** rendering.
- No External Tools Needed: Type standard Mermaid markup directly in a specialized code block (e.g., flowcharts, sequence diagrams, state machines).
- Live Rendering: The editor automatically compiles and renders the diagram inline as an interactive SVG graph.
- Quick Edit: Double-click the rendered diagram to reopen the raw markup drawer, modify your structure, and apply changes in real time.
// Double-click diagram block to edit Mermaid markup inline:
graph TD
A[Client Request] --> B[API Load Balancer]
B --> C[Fastify ECS API]
C --> D[(PostgreSQL database)] Productivity Page Templates
Accelerate documentation with pre-formatted page templates tailored for agile teams. When creating a page, choose from:
- Meeting Notes: Agenda, attendees, notes, and checklist action items.
- Product Spec (PRD): Business value, success metrics, user stories, and requirements.
- Technical Spec: Architecture overview, schema definitions, and API route declarations.
- Project Retrospective: Structured retrospectives containing columns for what went well, improvements, and action items.
- Onboarding Guide: Welcomes new hires, explains env setup, and details team contacts.
- Status Report: Weekly summaries of progress, blockers, and upcoming milestones.
- Root Cause Analysis (RCA): Incident details, event timeline, root cause analysis, and prevention items.
Global vs. Project Scopes
Control where your knowledge lives based on who needs access:
- Project Wiki: Scoped to a specific project. Perfect for features, release notes, API specs, and technical documentation.
- Global Wiki: Scoped to the entire workspace. Ideal for general developer handbooks, HR policies, onboarding materials, and company-wide procedures.
Collaboration Control & Page Locking
Collaborate safely without overwriting other team members' changes.
- Active Page Locking: When an editor opens a page for editing, Klority locks the document (`lockedBy` and `lockedAt`), displaying a warning banner to other users to prevent edit conflicts.
- Granular Sharing Permissions: Share pages with specific emails or groups, configuring permissions to `Read`, `Edit`, or `Admin` control.
- Discussion Threads: Add page-level comments to discuss specs, review drafts, and resolve feedback without cluttering document content.
Revisions & Version History
Never lose work. Klority keeps a complete, granular history of all page edits.
- Automatic Versioning: Every manual save creates a timestamped version snapshot linked to the user who saved it.
- Compare Revisions: View past versions to inspect changes over time.
- One-Click Restore: Instantly roll back a page to any previous version, restoring both content and attachments.
Contextual Linking & Traceability
Link your documentation directly to your tasks and QA cycles. When you link a wiki specification to an active task card or test cycle, it displays on both sides, letting engineers read the exact specification description directly from their backlog drawer.