Darstellung: Inline-Code-Chips fuer Dark Mode, 58 Seiten auf .mdx (Komponenten rendern jetzt)
Befund 1 (Nutzer): Inline-Code war im Dark Mode kaum lesbar.
- src/styles/custom.css: eigene Chip-Farben (--tibi-inline-*), Rahmen, nowrap in der ersten Tabellenspalte
- gemessen: Text/Chip 10,2:1 dunkel, 12,4:1 hell
Befund 2 (beim Nachmessen gefunden): 58 Seiten waren .md - Starlight-Komponenten wurden NICHT gerendert
(rohe <Aside>/<Steps>-Tags, import-Zeile als sichtbarer Text auf 57 Seiten).
- alle 58 Seiten auf .mdx umgestellt und MDX-konform gemacht (Imports, Block-Tags in eigenen Zeilen,
HTML-Kommentare -> {/* */}, geschweifte Klammern escaped)
- nachher: 428 Asides, 87 Steps, 158 Tab-Gruppen gerendert, 0 geleakte Imports
- fehlender Import in reference/hooks-daten ergaenzt
Regressionsschutz: audit-docs.mjs prueft jetzt Komponente-ohne-Import, .md-mit-Komponente,
geleakte Imports und rohe Tags im gebauten dist/. AGENTS.md 3 dokumentiert die .mdx-Regel.
Nebenfund: de.json mit ASCII-Umschreibungen -> Issue tibi-admin-nova #6
Build: 71 Seiten gruen, Audit 7 legitime Platzhalter-Marker
This commit is contained in:
1 parent
06c5f0d8ea
commit
dcdb6ee637
64 files changed
+246
-104
No files matched your search
@@ -38,6 +38,12 @@ Jede Seite nennt ihre Quelle-der-Wahrheit (Code zuerst), hat einen Stempel am En
|
||||
## 3. Neue Seite anlegen
|
||||
|
||||
- Datei `src/content/docs/<bereich>/<slug>.md` mit Frontmatter `title` + `description`.
|
||||
- **Sobald die Seite eine Starlight-Komponente nutzt (`<Aside>`, `<Steps>`, `<Tabs>`, `<Card>`, `<LinkCard>`, `<Badge>`, `<FileTree>`), muss die Datei `.mdx` heißen.** In reinem Markdown (`.md`) werden Komponenten-Tags **nicht** gerendert: sie landen als unbekannte HTML-Tags im Ergebnis, und die `import`-Zeile erscheint als sichtbarer Text auf der Seite (`scripts/audit-docs.mjs` prüft das gegen `dist/`).
|
||||
- MDX-Regeln, die die Konvertierung erfüllen muss:
|
||||
- `import …` steht als erste Zeile **vor** dem Inhalt (nach dem Frontmatter).
|
||||
- Block-Komponenten: öffnendes Tag in eigener Zeile, Inhalt, schließendes Tag in eigener Zeile (nicht `Text</Aside>` in einer Zeile).
|
||||
- Kommentar-Hinweise als `{/* … */}` schreiben, **nicht** als `<!-- … -->`.
|
||||
- Geschweifte Klammern im Fließtext escapen (`\{count\}`) — in Code-Spans und Codeblöcken nicht nötig.
|
||||
- Sidebar: jede Gruppe explizit in `astro.config.mjs` eintragen (beim Neuaufbau pro Bereich ergänzen; `autogenerate` erst nutzen, sobald der Ordner gepflegt befüllt ist).
|
||||
- Bilder nach `src/assets/`, max. 200 KB, deutsche Alt-Texte.
|
||||
- Screenshots: nur Mock-Projekt `corporate` (nie `t1`), Ablauf unter `plans/t-shots-arbeitsauftrag.md`.
|
||||
@@ -57,6 +63,9 @@ npm run build # muss grün durchlaufen (prüft interne Links NIC
|
||||
- `scripts/audit-docs.mjs` meldet tote Links/Anker, kaputte Tabellen, fehlende Alt-Texte und offene
|
||||
Platzhalter-Marker. Ergebnis **muss** „0 tote Links, 0 kaputte Tabellen" sein; verbleibende Marker
|
||||
sind zu begründen.
|
||||
- Zusätzlich prüft das Skript das **gebaute** `dist/`: geleakte `import`-Zeilen, rohe `<Aside>`/`<Steps>`-Tags
|
||||
und fehlende Komponenten-Klassen. Erst `npm run build`, dann `node scripts/audit-docs.mjs` — so fällt auf,
|
||||
wenn eine Seite als `.md` statt `.mdx` angelegt wurde.
|
||||
- `scripts/gen-schema-matrix.mjs` und `reference/schema-properties.md` sind ein Paar: Seite nie von Hand
|
||||
editieren, Schemas nie in der Doku nachpflegen — nur `npm run gen:schemas` laufen lassen.
|
||||
- `scripts/sync-server-docs.mjs` ist **stillgelegt** (der Server-Sync erzeugte verwaiste Seiten ohne
|
||||
|
||||
Reference in new issue
Block a user