Skip to content

How To Publish

PardhuVarma Konduru edited this page Jul 5, 2026 · 1 revision

How to publish this as your GitHub Wiki

GitHub Wikis are just a separate git repository: https://github.com/<owner>/<repo>.wiki.git. Every file here maps 1:1 to a wiki page (filename minus .md = page title, dashes render as spaces).

Option A — push via git (recommended)

  1. In your repo on GitHub, open the Wiki tab once and click "Create the first page" (this initializes the .wiki.git repo — required before you can push to it).
  2. Clone the wiki repo locally:
    git clone https://github.com/<owner>/kernel-borderlands.wiki.git
    
  3. Copy every .md file from this folder into that clone (overwrite the placeholder Home.md):
    cp /path/to/this/wiki/*.md kernel-borderlands.wiki/
    
  4. Commit and push:
    cd kernel-borderlands.wikigit add .git commit -m "Import full project wiki"git push
    

Option B — paste manually

For each file, create a new wiki page in the GitHub UI with the same title (spaces instead of dashes, e.g. Zone-Model-And-Scoring.md → page title Zone Model And Scoring) and paste the contents.

Files in this set

File Page
Home.md Home (landing page)
_Sidebar.md Custom sidebar nav (GitHub renders this automatically if present)
Architecture.md Architecture
Zone-Model-And-Scoring.md Zone Model And Scoring
Wire-Protocol.md Wire Protocol
Event-Contract.md Event Contract
Kernel-Hook-Points.md Kernel Hook Points
Cross-Kernel-Portability.md Cross Kernel Portability
Getting-Started.md Getting Started
kb-core.md kb-core
kb-control-plane.md kb-control-plane
kb-aads.md kb-aads
kb-dashboard.md kb-dashboard
kb-tui.md kb-tui
kb-checker.md kb-checker
Team.md Team
Contributing.md Contributing
FAQ.md FAQ

All internal cross-links use [[Double Bracket]] wiki-link syntax, which GitHub resolves automatically to the matching page — no changes needed after import.

Keeping it in sync

Since these pages summarize content that also lives in docs/, README.md, and per-subsystem README.md/readme.md files, treat the wiki as documentation that should be updated alongside any change to:

  • the wire protocol (kb-core/userspace/bridge/, kb-control-plane/internal/ipc/)
  • the event contract (docs/architecture/kbd-contracts.md)
  • scoring weights/thresholds (kb-core/include/kb_scoring.h, config/policy.yaml)
  • subsystem ownership (docs/project/kb-team.md)

Clone this wiki locally