Files changed: - .gitignore - AGENTS.md - CHANGES.md - VERSION - docs/explanation/architecture.md - docs/how-to/README.md - docs/how-to/write-a-site-handler.md - docs/reference/commands/instance-health.md - docs/reference/commands/raw-material-and-uploads.md - docs/reference/configuration.md - instructions/dev/doc-pull-through.md - raw/CONTRACT.md - sites/CONTRACT.md - tools/CONTRACT.md - tools/README.md - tools/chemenu/commands/dist_cmd.py - tools/chemenu/commands/docs_verify.py - tools/chemenu/commands/doctor.py - tools/chemenu/commands/git_publish.py - tools/chemenu/commands/raw/fetch.py - tools/chemenu/ownership.py - tools/chemenu/sites/__init__.py - tools/chemenu/sites/data.py - tools/chemenu/sites/handlers/learn-microsoft-powershell-module.json - tools/chemenu/sites/handlers/learn-microsoft.json - tools/chemenu/sites/learn_microsoft.py - tools/chemenu/sites/site.schema.json - tools/chemenu/tests/test_dist_cmd.py - tools/chemenu/tests/test_doctor.py - tools/chemenu/tests/test_site_files.py - tools/chemenu/toc.py Co-Authored-By: Claude Code <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2
33 lines
1.7 KiB
Markdown
33 lines
1.7 KiB
Markdown
# 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](ingest-a-source.md) - a file, a folder, a web page, or a document submitted
|
|
through the MCP server
|
|
- [Write a site handler](write-a-site-handler.md) - teach `raw fetch` how a website serves its pages
|
|
- [Capture documentation from a git repository](capture-repository-docs.md) - and keep it current
|
|
- [Export guidelines to captured repositories](export-guidelines.md)
|
|
- [Query the wiki](query-the-wiki.md) - asking, and searching yourself
|
|
- [Maintain the wiki](maintain-the-wiki.md) - lint, provenance, and the gates on the way to a publish
|
|
- [Run the weekly review](run-the-weekly-review.md) - commitments in a task tracker against the
|
|
project pages
|
|
- [Browse the wiki in Obsidian](browse-with-obsidian.md) - and how pages are named
|
|
|
|
Running the instance:
|
|
|
|
- [Update an instance](update-an-instance.md) - to a newer release of the stack
|
|
- [Troubleshoot an instance](troubleshoot.md)
|
|
- [Set up the MCP read server](set-up-the-mcp-server.md) - for a consumer that is not a terminal
|
|
on this machine
|
|
- [Trace and score agent sessions](trace-and-score-sessions.md)
|
|
- [Use 1Password for settings](use-1password-for-settings.md) - secrets and private values out
|
|
of the tree, on the desktop and in CI
|
|
|
|
Installing a new instance is [INSTALL.md](../../INSTALL.md) at the repository root.
|