feat: docs reference generates a skill catalogue and a page-type reference under docs/reference/ from the shipped defaults, checked and written in the origin repo only (#189)
Files changed: - CHANGES.md - README.md - VERSION - docs/reference/README.md - docs/reference/commands/README.md - docs/reference/commands/types-instructions-and-docs.md - docs/reference/page-types.md - docs/reference/skills.md - instructions/dev/doc-pull-through.md - tools/CONTRACT.md - tools/README.md - tools/chemenu/commands/docs_verify.py - tools/chemenu/reference_doc.py - tools/chemenu/tests/test_reference_doc.py Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01SnAJ7Z3CpVD3PRbN73QtU2
This commit is contained in:
1 parent
d644a1d4f7
commit
070cae6aad
14 files changed
+606
-65
No files matched your search
+11
-10
@@ -14,7 +14,7 @@ place only: `instructions/dev/version-parts.md` § The candidate model.
|
||||
|
||||
---
|
||||
|
||||
## 9.0.0-beta.4 - 2026-10-06 - tools/README.md module tree names reference_doc.py and the fourth view cli_contract renders
|
||||
## 9.0.0-beta.5 - 2026-10-06 - docs reference: skill catalogue and page types under docs/reference/, generated from the shipped defaults in the origin repo only
|
||||
|
||||
**Author:** Torben Nehmer
|
||||
|
||||
@@ -29,6 +29,7 @@ place only: `instructions/dev/version-parts.md` § The candidate model.
|
||||
**Medium impact**
|
||||
- Changelog kompakt: ein Absatz pro Thema, Größenbudget, Migrationsverweis
|
||||
- docs reference: human command reference under docs/reference/, generated from the command records
|
||||
- docs reference: skill catalogue and page types under docs/reference/, generated from the shipped defaults in the origin repo only
|
||||
|
||||
**Low impact**
|
||||
- version bump: Abschlussmeldung nennt Stichpunkt oder Themenabsatz statt pauschal Prosa
|
||||
@@ -57,16 +58,16 @@ Migrationsdokument auf die Basis des Kandidaten, schreibt jeder `version bump` d
|
||||
grenzüberschreitenden Eintrag, der sein Dokument nicht nennt. Die Formregeln stehen nur noch in
|
||||
`instructions/dev/version-parts.md`.
|
||||
|
||||
### Kommandoreferenz für Menschen unter `docs/reference/` (#188)
|
||||
### Generierte Referenz für Menschen unter `docs/reference/` (#188, #189)
|
||||
|
||||
Der neue Befehl `wikitool docs reference [--apply]` erzeugt aus den Kommando-Datensätzen eine Seite
|
||||
je Gruppe unter `docs/reference/commands/`, eine Übersicht in deren `README.md` und
|
||||
`docs/reference/exit-codes.md` mit den Gates und allen Ursachen für Exit 42. Die Seiten zeigen
|
||||
Synopsis, Optionen, Beispiele, Verhalten, Eigenschaften in Worten und Exit-Codes mit Ursache,
|
||||
nicht aber die an Agenten gerichteten ON-FAILURE-Reaktionen und NEVER-Zeilen. Titel und Kopfsatz
|
||||
schreibt ein Mensch; das Werkzeug legt keine Seite an. `docs verify` meldet eine veraltete Region,
|
||||
eine Gruppe ohne Seite und eine Seite ohne Gruppe, solange es `docs/` gibt. Das Inhaltsverzeichnis
|
||||
kommt nie mehr in eine andere generierte Region hinein.
|
||||
`wikitool docs reference [--apply]` erzeugt aus den Kommando-Datensätzen eine Seite je Gruppe unter
|
||||
`docs/reference/commands/` samt Übersicht und `exit-codes.md` mit Gates und Exit-42-Ursachen, ohne
|
||||
die an Agenten gerichteten Reaktionen und NEVER-Zeilen. Dazu kommen `skills.md`, der Katalog der
|
||||
ausgelieferten Skills aus ihrer `description`, und `page-types.md` mit Subtypen, Zielverzeichnissen
|
||||
und Pflichtfeldern je `root: kb`-Type-Spec. Diese beiden beschreiben die ausgelieferten Vorgaben
|
||||
und werden nur im Ursprungs-Repo erzeugt und geprüft; in einer Instanz lässt `docs reference` sie
|
||||
unberührt. Titel und Kopfsatz schreibt ein Mensch. `docs verify` meldet veraltete Regionen und
|
||||
fehlende Seiten, solange es `docs/` gibt.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in new issue
Block a user