Table of Contents

How-to guides

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Generated from docs/how-to/README.md at v10.1.0 – edit the repository, not this wiki.

How-to guides

Task-oriented pages for the operator of an instance: one goal per page - upgrade an instance, set up the MCP read server, run a weekly review - with the steps a human takes and the sentence handed to the agent. A how-to guide never retells an agent's procedure: the steps an agent runs live in instructions/, and a guide here says what to prepare, what to ask for and where the agent stops.

Working with the wiki:

Ingest a source - a file, a folder, a web page, or a document submitted through the MCP server
Write a site handler - teach raw fetch how a website serves its pages
Fetch pages behind a login - with your own session, through a browser, or through a fetch program of your own
Capture documentation from a git repository - and keep it current
Export guidelines to captured repositories
Export to a synced folder - a read-only version of selected pages for a reader outside the repository, OneDrive and Microsoft 365 included
Query the wiki - asking, and searching yourself
Maintain the wiki - lint, provenance, and the gates on the way to a publish
Run the weekly review - commitments in a task tracker against the project pages
Browse the wiki in Obsidian - and how pages are named

Running the instance:

Update an instance - to a newer release of the stack
Troubleshoot an instance
Set up the MCP read server - for a consumer that is not a terminal on this machine
Trace and score agent sessions
Use 1Password for settings - secrets and private values out of the tree, on the desktop and in CI
Collect documents from a synced folder - a folder OneDrive and the like fill, or a program of your own, as an intake channel into the quarantine
Back up to a synced folder - OneDrive and the like as the backup of an instance without a git server, and restoring from it

Installing a new instance is INSTALL.md at the repository root.