feat: INSTALL.md is the English installation tutorial; new tutorial docs/tutorials/first-source-to-first-answer.md with a shipped sample source; README.md links it as its first-ingestion step (#191)
Files changed: - CHANGES.md - INSTALL.md - README.md - VERSION - docs/reference/commands/types-instructions-and-docs.md - docs/tutorials/README.md - docs/tutorials/first-source-to-first-answer.md - docs/tutorials/sample-source.md - instructions/dev/doc-pull-through.md - tools/CONTRACT.md - tools/chemenu/commands/docs_verify.py - tools/chemenu/install_doc.py - tools/chemenu/tests/test_install_doc.py Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2
This commit is contained in:
1 parent
f9056c04f7
commit
fe1de63e0f
13 files changed
+403
-190
No files matched your search
+6
-1
@@ -14,7 +14,7 @@ place only: `instructions/dev/version-parts.md` § The candidate model.
|
||||
|
||||
---
|
||||
|
||||
## 9.0.0-beta.6 - 2026-10-06 - docs/: how-to guides, configuration reference and two explanation pages carved out of README.md, INSTALL.md, INSTALL-MCP.md and EVALS.md; the last two retired
|
||||
## 9.0.0-beta.7 - 2026-10-07 - INSTALL.md is an English installation tutorial; new tutorial from a first source to a first answer with a shipped sample; README.md a landing page
|
||||
|
||||
**Author:** Torben Nehmer
|
||||
|
||||
@@ -31,6 +31,7 @@ place only: `instructions/dev/version-parts.md` § The candidate model.
|
||||
- docs reference: human command reference under docs/reference/, generated from the command records
|
||||
- docs reference: skill catalogue and page types under docs/reference/, generated from the shipped defaults in the origin repo only
|
||||
- docs/: how-to guides, configuration reference and two explanation pages carved out of README.md, INSTALL.md, INSTALL-MCP.md and EVALS.md; the last two retired
|
||||
- INSTALL.md is an English installation tutorial; new tutorial from a first source to a first answer with a shipped sample; README.md a landing page
|
||||
|
||||
**Low impact**
|
||||
- version bump: Abschlussmeldung nennt Stichpunkt oder Themenabsatz statt pauschal Prosa
|
||||
@@ -38,6 +39,10 @@ place only: `instructions/dev/version-parts.md` § The candidate model.
|
||||
- tools/README.md module tree names reference_doc.py and the fourth view cli_contract renders
|
||||
<!-- /wikitool:bumps -->
|
||||
|
||||
### Tutorials: installation in English, and a first source to a first answer (#191)
|
||||
|
||||
`INSTALL.md` stays at the root and is now the English installation tutorial, the first one `docs/tutorials/README.md` lists; its generated prerequisites lists and `setup-question` markers are unchanged, and `docs verify`'s finding for a missing question names the English section "What the agent asks you". The new `docs/tutorials/first-source-to-first-answer.md` walks a fresh instance through one ingest and two questions, one the wiki answers with citations and one it has no source for, using `docs/tutorials/sample-source.md`, a short made-up note that ships with every instance. `README.md`'s "Your first ingestion" is a link to it, which finishes `README.md` as a landing page.
|
||||
|
||||
### The root documents split into `docs/` pages (#190)
|
||||
|
||||
The task and explanation parts of `README.md`, `INSTALL.md`, `INSTALL-MCP.md` and `EVALS.md` are now single English pages: eleven how-to guides under `docs/how-to/` (ingest, capture, guideline export, query, maintenance, weekly review, Obsidian, updating an instance, troubleshooting, the MCP read server, tracing and scoring sessions), a hand-written `docs/reference/configuration.md`, and `docs/explanation/architecture.md` and `telemetry-and-evaluation.md`. A guide says what to prepare, what to tell the agent and where it stops; it links an agent's procedure instead of retelling it. `INSTALL-MCP.md` and `EVALS.md` are gone from the root and from `dist export`, so an upgrade removes them as retired; `README.md` is a landing page, and `INSTALL.md` keeps only the installation itself. Pointers in messages and command records, among them `version check`'s, name the new pages.
|
||||
|
||||
Reference in new issue
Block a user