Files
werkbaum/frontend/public/llms.txt
T
mhoennigandClaude Opus 5 48d3174684 feat(site): llms.txt als Wegweiser + Charset-Fix für llms.md
Anlass war die Frage, ob `llms.md` ein guter Name ist. Zwei Befunde:

1. Der Zweck der Konvention ist ein anderer, als D43 annahm. llmstxt.org
   über die eigene Datei: „a markdown file that provides brief background
   information and guidance, along with links to markdown files providing
   more detailed information“ — ein Index, kein Inhalt. Der 211-Zeilen-
   Leitfaden ist genau eine jener verlinkten Dateien; `llms.md` ist damit
   der richtige Name, es fehlte der Wegweiser davor.

2. `llms.md` kam auf der stabilen Instanz falsch kodiert an: Apache kennt
   `.md` nicht und sendet GAR KEINEN Content-Type, der Browser rät
   windows-1252. Gemessen: characterSet=windows-1252, aus „notation —
   guide“ wurde „notation â€" guide“, 31 Zeilen betroffen. GitHub Pages
   liefert dieselbe Datei korrekt als text/markdown; charset=utf-8 aus.

- frontend/public/llms.txt: Index nach der Konvention (Titel, Blockquote,
  Notation in Kurzform, ## Docs, ## Optional). Rein ASCII — er ist die
  Datei, die ein fremder Agent ungefragt abruft, und soll auch dort
  ankommen, wo ein Server die Kodierung verschweigt. Alle 5 Links: 200.
- scripts/prod.htaccess: AddType für .md/.txt/.werkbaum, von
  deploy-prod.sh als .htaccess gespiegelt. Nicht in public/ — dort landete
  es wirkungslos im Pages-Artefakt. Rückweg bei 500 steht in der Datei.
- Beide Deploy-Wege kopieren llms.txt mit.

SPEC §13 + D43-Nachtrag 2 (mit Richtigstellung der D43-Annahme);
Plan: #not.llms.index [x]. 243 Tests grün, Plan 157 Knoten, 0 Warnungen.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-24 11:01:51 +02:00

34 lines
1.6 KiB
Plaintext

# Werkbaum
> A plain-text notation for work breakdown structures (WBS) with and/or
> decomposition, plus a browser editor that renders it as a diagram. This file
> is an index; the notation itself is explained in the guide linked below.
A Werkbaum plan is ordinary UTF-8 text, one node per line. Indentation carries
the hierarchy, and the leading character says how the children relate: `-` all
required, `+` an optional extra, `|` alternatives, `=` exactly one of them. A
checkbox such as `[x]` gives the status, `(M)` the T-shirt size. Nothing else
is needed to store, share or version a plan.
## Docs
- [Notation guide](https://werkbaum.javagil.de/llms.md): Everything needed to
read and write the notation, in English: line format and extraction order,
gates, status codes and progress ranks, sizes, node ids, dependencies,
folding marks, descriptions, plus a complete example. Self-contained; start
here.
- [Specification](https://github.com/mhoennig/werkbaum/blob/main/docs/SPEC.md):
The normative language definition (German). Where it and the guide disagree,
it wins.
- [Editor](https://werkbaum.javagil.de/): Renders a plan as a diagram.
`?sourceUrl=<url>` loads any CORS-readable http(s) text file, and
`?etherpad=<pad-url>` follows a live Etherpad.
## Optional
- [Design decisions](https://github.com/mhoennig/werkbaum/blob/main/docs/DECISIONS.md):
Why the notation looks the way it does, at length (German). Background only,
not needed to read or write plans.
- [Repository](https://github.com/mhoennig/werkbaum): Source and example plans
under `docs/examples/*.werkbaum`.