From d644a1d4f7eb9c83ed30f6b1c828957d99c51fc5 Mon Sep 17 00:00:00 2001 From: Torben Nehmer Date: Tue, 6 Oct 2026 21:40:45 +0200 Subject: [PATCH] docs: tools/README.md module tree names reference_doc.py and the fourth view cli_contract renders (#188) Files changed: - CHANGES.md - VERSION - tools/README.md Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2 --- CHANGES.md | 3 ++- VERSION | 2 +- tools/README.md | 3 ++- 3 files changed, 5 insertions(+), 3 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 43ee2d0..1904f74 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -14,7 +14,7 @@ place only: `instructions/dev/version-parts.md` § The candidate model. --- -## 9.0.0-beta.3 - 2026-10-06 - docs reference: human command reference under docs/reference/, generated from the command records +## 9.0.0-beta.4 - 2026-10-06 - tools/README.md module tree names reference_doc.py and the fourth view cli_contract renders **Author:** Torben Nehmer @@ -33,6 +33,7 @@ place only: `instructions/dev/version-parts.md` § The candidate model. **Low impact** - version bump: Abschlussmeldung nennt Stichpunkt oder Themenabsatz statt pauschal Prosa - AGENTS.md routing line and a toc.py docstring describe docs/ as the whole human documentation +- tools/README.md module tree names reference_doc.py and the fourth view cli_contract renders ### Doku-Gerüst nach Diátaxis unter `docs/` (#187) diff --git a/VERSION b/VERSION index 94ecc60..696cc4d 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -9.0.0-beta.3 +9.0.0-beta.4 diff --git a/tools/README.md b/tools/README.md index 26dffc0..5acb365 100644 --- a/tools/README.md +++ b/tools/README.md @@ -81,7 +81,7 @@ tools/ bugreport.py the bug-report collector itself - see below chemenu/ cli.py Typer app: registers every command, runs the budget gate, renders `-h`/`--help` from cli_contract - cli_contract.py one data record per command (name, synopsis, properties, exit status) - the source `-h`, the index and CONTRACT.md's generated region render from + cli_contract.py one data record per command (name, synopsis, properties, exit status) - the source `-h`, the index, CONTRACT.md's generated region and the human reference under docs/reference/ render from config.py repo layout: root resolution and every path under it api.py the in-process entry point - point Chemenu at a corpus and read it errors.py ChemenuError / ValidationError / BackendError @@ -89,6 +89,7 @@ tools/ filelock.py an exclusive lock on an open file, flock on POSIX and msvcrt on Windows - the only module that imports either prerequisites.py prerequisites.txt read from Python, plus the platform and long-path questions `doctor` asks install_doc.py INSTALL.md held to the instructions: its prerequisites lists generated from prerequisites.txt, its setup questions matched to setup-instance.md's markers + reference_doc.py the human command reference under docs/reference/: one page per command group, an overview and the exit-42 causes, rendered from the records without what addresses an agent corpus_cache.py one parsed corpus per commit, never cached while the tree is dirty kb_scan.py page iteration/loading over kb/ blocks.py generated regions in a page body, found by marker rather than by heading