Shield Docs

Design System

Web Components

Dokumentationsprinzipien

Diese Regeln definieren das feste Muster fuer alle Komponenten-Demos in Astro, damit neue Entwickler und KI konsistent arbeiten.

Verbindliche Regeln

  • Jede Komponenten-Seite hat Custom Stories mit global synchronen HTML und Angular Tabs.
  • Angular-Demos nutzen Typen/Konstanten aus @shield/angular, keine manuell gepflegten String-Unions.
  • Feste Beispielsets werden direkt im Template ausgeschrieben, ohne ngFor Demo-Arrays.
  • Codebeispiele zeigen Minimal-Markup ohne interne Demo-Layout-Wrapper.
  • Storybook-Playground ist optional, aber empfohlen fuer interaktive Controls.
  • A11y-Hinweise sind Pflichtbestandteil jeder Komponenten-Seite.

Standardstruktur

  1. Overview
  2. Playground (falls vorhanden)
  3. Custom Stories mit HTML und Angular
  4. A11y und Guidelines

Repo Referenz

Die zentrale Richtlinie liegt in /apps/astro-start/DOCS_DEMO_PRINCIPLES.md und ist die Source of Truth fuer Devs und KI-Assistenten.