docs: README/INSTALL/DEVELOPMENT/docs point at -h and command records, not the old tables (#121)
CI / verify (push) Failing after 1m3s

Files changed:
- DEVELOPMENT.md
- INSTALL.md
- README.md
- docs/knowledge-and-commitment.md
This commit is contained in:
torben committed 2026-09-26 07:54:12 +02:00
1 parent 26e1018766
commit b79f083cc1
4 files changed
+15 -12

No files matched your search

+1 -1
View File
@@ -82,7 +82,7 @@ Die drei Verify-Befehle stehen oben in Schritt 3; was jeder von ihnen prüft, st
[tools/CONTRACT.md](tools/CONTRACT.md) und wird dort von `docs verify` gegen die tatsächliche [tools/CONTRACT.md](tools/CONTRACT.md) und wird dort von `docs verify` gegen die tatsächliche
CLI gehalten. Hier steht es bewusst **nicht** noch einmal: eine zweite Beschreibung derselben CLI gehalten. Hier steht es bewusst **nicht** noch einmal: eine zweite Beschreibung derselben
Befehle ist genau die Kopie, die driftet (AGENTS.md Invariante 8), und dieses Dokument liegt Befehle ist genau die Kopie, die driftet (AGENTS.md Invariante 8), und dieses Dokument liegt
außerhalb der Dateien, die der Kommandotabellen-Check von `docs verify` abdeckt - hier fällt eine außerhalb der Dateien, die der Kommando-Datensatz-Check von `docs verify` abdeckt - hier fällt eine
Drift also niemandem auf. Was `pytest` an dieser Stelle vom Entwickler erwartet, steht in Drift also niemandem auf. Was `pytest` an dieser Stelle vom Entwickler erwartet, steht in
[instructions/dev/testing-conventions.md](instructions/dev/testing-conventions.md). [instructions/dev/testing-conventions.md](instructions/dev/testing-conventions.md).
+2 -1
View File
@@ -242,7 +242,8 @@ eingeschlossen, sha256-Vergleich von Hand). `dist upgrade` ersetzt genau diesen
dennoch von Hand nachvollziehen will oder muss (ein Werkzeug, das `wikitool` selbst nicht dennoch von Hand nachvollziehen will oder muss (ein Werkzeug, das `wikitool` selbst nicht
ausführen kann), findet die Dateiliste im `files`-Block der `.wikitool-release.json` und die ausführen kann), findet die Dateiliste im `files`-Block der `.wikitool-release.json` und die
Ausnahmen (`kb/CONVENTIONS.md`, `kb/*/COLLECTION.md`, `.wikitool-kb.json`) in Ausnahmen (`kb/CONVENTIONS.md`, `kb/*/COLLECTION.md`, `.wikitool-kb.json`) in
[tools/CONTRACT.md](tools/CONTRACT.md)s `dist upgrade`-Zeile. [tools/CONTRACT.md](tools/CONTRACT.md)s `dist upgrade`-Datensatz (oder direkt:
`tools/wikitool dist upgrade -h`).
## Konfiguration ## Konfiguration
+11 -9
View File
@@ -134,7 +134,7 @@ chemenu/
├── reports/ # DERIVED: lint reports, traces, eval scores. Gitignored ├── reports/ # DERIVED: lint reports, traces, eval scores. Gitignored
│ └── CONTRACT.md │ └── CONTRACT.md
└── tools/ # COMPILER: the wikitool CLI └── tools/ # COMPILER: the wikitool CLI
├── CONTRACT.md # Command reference, error contracts, maintenance schedule ├── CONTRACT.md # Command records (generated) and index, maintenance schedule
└── README.md # How wikitool is built and how to change it └── README.md # How wikitool is built and how to change it
``` ```
@@ -411,16 +411,18 @@ Mechanical wiki operations - never hand-edited by the LLM - are handled by
`tools/wikitool`: scaffolding pages, renaming and deleting them, cross-references, `tools/wikitool`: scaffolding pages, renaming and deleting them, cross-references,
index/log/provenance regeneration, structural linting, and publishing. index/log/provenance regeneration, structural linting, and publishing.
The full command reference - every option, the per-command error contracts, and Every command carries one data record - synopsis, properties, exit status,
the maintenance schedule - is in [`tools/CONTRACT.md`](tools/CONTRACT.md). It is retry policy - kept next to its code. `tools/wikitool <command> -h` prints it,
the single place that list lives, and `tools/wikitool docs verify` checks it `tools/wikitool -h` prints a one-line index of all of them, and
against the CLI in both directions. [`tools/README.md`](tools/README.md) is the [`tools/CONTRACT.md`](tools/CONTRACT.md) holds a generated copy together with the
other half: how the CLI is built and how to add a command. `AGENTS.md` holds the maintenance schedule; `tools/wikitool docs verify` checks that copy and every
invariants that say when each command is mandatory. command's flags against the CLI in both directions. [`tools/README.md`](tools/README.md)
is the other half: how the CLI is built and how to add a command. `AGENTS.md`
holds the invariants that say when each command is mandatory.
```bash ```bash
tools/wikitool --help tools/wikitool -h
tools/wikitool <command> --help tools/wikitool <command> -h
``` ```
<!-- dist:strip-start --> <!-- dist:strip-start -->
+1 -1
View File
@@ -5,7 +5,7 @@ Those look like one subject - both are "things about my projects" - and the stac
keeps them apart: `kb/gtd/` holds one page per initiative, an external task tracker holds the keeps them apart: `kb/gtd/` holds one page per initiative, an external task tracker holds the
open items, and the only thing that crosses between them is a name. This page is about why that open items, and the only thing that crosses between them is a name. This page is about why that
line was drawn there. The rules that follow from it live in [kb/CONTRACT.md](../kb/CONTRACT.md) line was drawn there. The rules that follow from it live in [kb/CONTRACT.md](../kb/CONTRACT.md)
and the `review`, `new project` and `task new` rows of [tools/CONTRACT.md](../tools/CONTRACT.md). and the `review`, `new` and `task new` records in [tools/CONTRACT.md](../tools/CONTRACT.md).
<!-- wikitool:toc --> <!-- wikitool:toc -->
## Contents ## Contents