KN Docs Overview
Version 1 · Create the initial project overview page for KN Docs in QDG KB
KN Docs Overview
KN Docs is the repository used to maintain the QDG KB project documentation, the updatewiki skill, and the local documentation workflow for this workspace.
Purpose
This repository documents the QDG KB system itself and provides a working example of how a project can publish durable, versioned Markdown knowledge through the QDG KB MCP tools.
The goal is to keep project knowledge discoverable, reviewable, and versioned while preserving a clear change history.
Repository structure
README.md— project overview and local setup guidancedocs/— user documentation and quick referencesskills/updatewiki/— installation and usage instructions for theupdatewikiskillsrc/qdgkb/— the QDG KB Python server and database layertests/— unit and integration coveragescripts/— setup and maintenance utilities
Core concepts
QDG KB stores documentation as Markdown pages in the Odin qdgwiki schema. Each page can be updated through the updatewiki skill, and every publish creates a new immutable version with metadata such as:
- change description
- author
- optional task reference
- optional commit reference
The system intentionally separates editorial decision-making from database validation:
- the AI decides what durable information belongs in a page
- the MCP server validates the content and enforces version checks
Local workflow
This workspace is designed to run locally with Python and PowerShell. Typical setup and verification commands are:
powershell -ExecutionPolicy Bypass -File scripts\bootstrap.ps1
powershell -ExecutionPolicy Bypass -File scripts\migrate.ps1 status
powershell -ExecutionPolicy Bypass -File scripts\migrate.ps1 apply
powershell -ExecutionPolicy Bypass -File scripts\verify.ps1
powershell -ExecutionPolicy Bypass -File scripts\run-local.ps1
Documentation workflow
The standard pattern is:
- Identify the relevant QDG KB project.
- Select or create the target page.
- Read the current page and the new evidence.
- Produce a complete revised Markdown page.
- Publish it through the QDG KB MCP layer.
Examples include:
updatewiki create project documentation
updatewiki quick reference with docs\quick-reference.md
updatewiki user guide with docs\user-guide.md
findwiki how is QDG KB connected to QWebHub?
Related files
This repository acts as the documentation and operational reference for the QDG KB workflow itself.