docs: README/INSTALL/DEVELOPMENT/docs point at -h and command records, not the old tables (#121)
CI / verify (push) Failing after 1m3s
CI / verify (push) Failing after 1m3s
Files changed: - DEVELOPMENT.md - INSTALL.md - README.md - docs/knowledge-and-commitment.md
This commit is contained in:
1 parent
26e1018766
commit
b79f083cc1
4 files changed
+15
-12
No files matched your search
@@ -134,7 +134,7 @@ chemenu/
|
||||
├── reports/ # DERIVED: lint reports, traces, eval scores. Gitignored
|
||||
│ └── CONTRACT.md
|
||||
└── 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
|
||||
```
|
||||
|
||||
@@ -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,
|
||||
index/log/provenance regeneration, structural linting, and publishing.
|
||||
|
||||
The full command reference - every option, the per-command error contracts, and
|
||||
the maintenance schedule - is in [`tools/CONTRACT.md`](tools/CONTRACT.md). It is
|
||||
the single place that list lives, and `tools/wikitool docs verify` checks it
|
||||
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.
|
||||
Every command carries one data record - synopsis, properties, exit status,
|
||||
retry policy - kept next to its code. `tools/wikitool <command> -h` prints it,
|
||||
`tools/wikitool -h` prints a one-line index of all of them, and
|
||||
[`tools/CONTRACT.md`](tools/CONTRACT.md) holds a generated copy together with the
|
||||
maintenance schedule; `tools/wikitool docs verify` checks that copy and every
|
||||
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
|
||||
tools/wikitool --help
|
||||
tools/wikitool <command> --help
|
||||
tools/wikitool -h
|
||||
tools/wikitool <command> -h
|
||||
```
|
||||
|
||||
<!-- dist:strip-start -->
|
||||
|
||||
Reference in new issue
Block a user