Skip to content
Kelly Ferrone edited this page Sep 21, 2026 · 2 revisions

notes/

Hand-written prose for the generated wiki pages.

Configuration, Tools and Endpoints are rendered from the code by python scripts/generate_wiki.py in the server repo, so editing one directly is pointless — the next run overwrites it. Anything a schema cannot express goes here instead:

notes/Configuration.notes.md   ->  appended to the Configuration wiki page

Create notes/<page>.notes.md and its contents are included near the bottom of that page, below the generated tables and above the footer links. Regenerating leaves it alone.

Use it for the things worth saying that a field table cannot: why one setting is usually the wrong one, what a failure normally means, the trap that cost somebody an afternoon. Not for restating a field's type.

The other pages — Home, Quick-Start, Installing, Deployment, Operations, Config-File, Sources, Plugins, Libraries, Skills, Prompts, Scoping — are hand-written in full. Edit those directly; the generator never touches them.

Why .notes.md and not <page>.md

A GitHub wiki addresses a page by basename, whatever directory it sits in. notes/Tools.md and Tools.md would therefore both answer to /wiki/Tools, and GitHub serves the fragment — so the page looks like it has lost everything but its prose while the file on disk is perfect.

The .notes.md suffix is what keeps the two apart. Do not drop it; tests/test_wiki.py fails on any page shadowed this way.

Clone this wiki locally