Files changed: - CHANGES.md - VERSION - docs/how-to/README.md - docs/how-to/back-up-to-a-synced-folder.md - docs/how-to/collect-from-a-synced-folder.md - docs/how-to/export-guidelines.md - docs/how-to/export-to-a-synced-folder.md - docs/reference/commands/README.md - docs/reference/commands/exports.md - docs/reference/commands/git.md - docs/reference/commands/guideline-export.md - docs/reference/commands/instance-health.md - docs/reference/commands/raw-material-and-uploads.md - docs/reference/configuration.md - docs/reference/exit-codes.md - instructions/setup-instance.md - raw/CONTRACT.md - tools/CONTRACT.md - tools/README.md - tools/chemenu/backup.py - tools/chemenu/cli_contract.py - tools/chemenu/commands/doctor.py - tools/chemenu/commands/export_cmd.py - tools/chemenu/commands/git_publish.py - tools/chemenu/commands/raw/_common.py - tools/chemenu/commands/raw/accept.py - tools/chemenu/commands/raw/capture.py - tools/chemenu/config_shapes.py - tools/chemenu/guideline_export.py - tools/chemenu/page_export.py - tools/chemenu/reference_doc.py - tools/chemenu/repo_capture.py - tools/chemenu/tests/test_config_shapes.py - tools/chemenu/tests/test_export_run.py Co-Authored-By: Claude Code <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2
41 lines
2.4 KiB
Markdown
41 lines
2.4 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
|
|
- [Fetch pages behind a login](fetch-pages-behind-a-login.md) - with your own session, through a
|
|
browser, or through a fetch program of your own
|
|
- [Capture documentation from a git repository](capture-repository-docs.md) - and keep it current
|
|
- [Export guidelines to captured repositories](export-guidelines.md)
|
|
- [Export to a synced folder](export-to-a-synced-folder.md) - a read-only version of selected pages
|
|
for a reader outside the repository, OneDrive and Microsoft 365 included
|
|
- [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
|
|
- [Collect documents from a synced folder](collect-from-a-synced-folder.md) - 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](back-up-to-a-synced-folder.md) - 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](../../INSTALL.md) at the repository root.
|