docs: tools/README.md module tree names reference_doc.py and the fourth view cli_contract renders (#188)
CI / verify (push) Successful in 6m12s
CI / pwsh (push) Successful in 2m0s
Release / release (push) Successful in 34s

Files changed:
- CHANGES.md
- VERSION
- tools/README.md

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2
This commit is contained in:
torbenandClaude Opus 5.5 committed 2026-10-06 21:40:45 +02:00
1 parent 53383e7e9b
commit d644a1d4f7
3 files changed
+5 -3

No files matched your search

+2 -1
View File
@@ -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 **Author:** Torben Nehmer
@@ -33,6 +33,7 @@ place only: `instructions/dev/version-parts.md` § The candidate model.
**Low impact** **Low impact**
- version bump: Abschlussmeldung nennt Stichpunkt oder Themenabsatz statt pauschal Prosa - 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 - 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
<!-- /wikitool:bumps --> <!-- /wikitool:bumps -->
### Doku-Gerüst nach Diátaxis unter `docs/` (#187) ### Doku-Gerüst nach Diátaxis unter `docs/` (#187)
+1 -1
View File
@@ -1 +1 @@
9.0.0-beta.3 9.0.0-beta.4
+2 -1
View File
@@ -81,7 +81,7 @@ tools/
bugreport.py the bug-report collector itself - see below bugreport.py the bug-report collector itself - see below
chemenu/ chemenu/
cli.py Typer app: registers every command, runs the budget gate, renders `-h`/`--help` from cli_contract 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 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 api.py the in-process entry point - point Chemenu at a corpus and read it
errors.py ChemenuError / ValidationError / BackendError 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 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 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 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 corpus_cache.py one parsed corpus per commit, never cached while the tree is dirty
kb_scan.py page iteration/loading over kb/ kb_scan.py page iteration/loading over kb/
blocks.py generated regions in a page body, found by marker rather than by heading blocks.py generated regions in a page body, found by marker rather than by heading