docs: README names examples, exit causes and prohibitions in the command record (#142)
CI / verify (push) Successful in 1m9s
CI / verify (push) Successful in 1m9s
Files changed: - README.md
This commit is contained in:
1 parent
5aae7fed1b
commit
5fe6003929
1 file changed
+3
-2
@@ -411,8 +411,9 @@ 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.
|
||||
|
||||
Every command carries one data record - synopsis, properties, exit status,
|
||||
retry policy - kept next to its code. `tools/wikitool <command> -h` prints it,
|
||||
Every command carries one data record - synopsis, properties, copyable examples,
|
||||
each exit cause with what to do about it, prohibitions, and notes on its
|
||||
behaviour - 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
|
||||
|
||||
Reference in new issue
Block a user