LLM-Dokumentationssystem

Die Onesown.Blazor.Components Library generiert automatisch Dokumentation, die LLMs wie GitHub Copilot, Claude oder ChatGPT direkt als Kontext nutzen können. Diese Seite erklärt das System – von der Quelldatei bis zum fertigen Prompt.

Copilot Instructions – Prompt für andere Projekte

Diesen Block in die .github/copilot-instructions.md des Projekts kopieren, das die Library verwendet. Damit weiß Copilot automatisch, wo es nachschlagen kann.

Tipp: Den Prompt oben in die copilot-instructions.md einfügen, damit er bei jedem Chat-Kontext geladen wird.

## Onesown.Blazor.Components – LLM-Kontext

Diese App verwendet die Onesown.Blazor.Components Library (Blazor Server, .NET 10).

### Dokumentationsquellen

Bevor du Komponenten verwendest oder Fragen dazu beantwortest, schlage in den folgenden
Dateien nach. Sie werden automatisch aus dem Quellcode generiert und sind immer aktuell:

- Komponentenübersicht:    https://components.schini.com/llms/llms.txt
- Design Tokens (CSS):     https://components.schini.com/llms/_shared/DESIGN-TOKENS.md
- CSS Utility-Klassen:     https://components.schini.com/llms/_shared/CSS-UTILITIES.md
- JavaScript Public API:   https://components.schini.com/llms/_shared/JS-API.md
- Einzelne Komponente:     https://components.schini.com/llms/KOMPONENTENNAME/SKILL.md

  Beispiele:
    https://components.schini.com/llms/Button/SKILL.md
    https://components.schini.com/llms/DataGrid/SKILL.md
    https://components.schini.com/llms/TextBox/SKILL.md

### Regeln

- Farben über OoColorPalette (OoColorPalette.Primary, OoColorPalette.Danger.Outline, …)
- Layout via Stack / Row / Column – kein manuelles flex CSS

Wie funktioniert das System?

Vom Quellcode zur LLM-lesbaren Dokumentation – vollautomatisch.

Der Generator liest drei Quellentypen:

C# Komponenten XML-Docs (/// <summary>, /// <remarks>) auf Klassen und [Parameter]-Properties in den .razor.cs-Dateien.

JavaScript //-Kommentare direkt über window.oo.*-Exporten in den wwwroot/js/*.js-Dateien.

CSS theme.css für Design Tokens (--oo-*), utils.css für Utility-Klassen. Sektionskommentare werden als Überschriften übernommen.

Das PowerShell-Skript generate-llm-docs.ps1 liest alle Quellen und erzeugt die Markdown-Dateien:

# Alle Komponenten + _shared/ neu generieren:
.\Onesown.Blazor.Components\generate-llm-docs.ps1

# Nur eine einzelne Komponente (schneller):
.\Onesown.Blazor.Components\generate-llm-docs.ps1 -OnlyComponent "TextBox"

Der Generator wird auch automatisch beim Build ausgeführt (MSBuild-Target). Nach jeder Änderung an XML-Docs, JS-Kommentaren oder CSS reicht ein normaler Build.

Alle generierten Dateien liegen unter wwwroot/llms/ und werden als statische Assets ausgeliefert:

llms/llms.txt – Einstiegspunkt (llmstxt.org-Standard), listet alle Komponenten

llms/_shared/DESIGN-TOKENS.md – alle CSS Custom Properties

llms/_shared/CSS-UTILITIES.md – alle Utility-Klassen

llms/_shared/JS-API.md – alle window.oo.*-Funktionen

llms/KOMPONENTENNAME/SKILL.md – eine Datei pro Komponente

Ein LLM (Copilot, Claude, ChatGPT) kann die Dateien über HTTP abrufen oder sie werden direkt als Kontext übergeben. Das SKILL.md jeder Komponente enthält:

Alle Parameter mit Typ + Beschreibung Verwendungshinweise (Remarks) Vererbte Basisklassen-Parameter Codebeispiele aus Demo-Seiten

Dokumentationsregeln auf einen Blick

Vollständige Regeln: Onesown.Blazor.Components/XMLDOC-GUIDE.md

Klasse: /// <summary> + /// <remarks>

<summary>: 1–2 Sätze, konkrete Features nennen

<remarks>: 4–8 Bullet-Punkte mit Parameter-Namen und Beispielwerten

Parameter: /// <summary> über jedem [Parameter]

Basisklassen-Parameter (Label, Size, …) nicht doppeln – werden automatisch geerbt

//-Kommentar direkt (ohne Leerzeile) über dem window.oo.*-Export

Parameter und ihren Effekt beschreiben

Alle vier Export-Muster werden erkannt: Funktionsreferenz, Arrow-Function, Objekt-Literal, IIFE

Interne Hilfsfunktionen ohne window.oo.* werden ignoriert

theme.css: Sektionen via /* ── Titel ── */

Inline-Kommentar hinter dem Wert wird als Beschreibung übernommen

utils.css: Sektionen via dreizeiligem ASCII-Art-Kommentarblock

Neue Utility-Klassen eintragen → Generator einmal laufen lassen → fertig

Warum dieser Ansatz?

Immer aktuell Dokumentation wird aus dem Quellcode generiert – kein manuelles Nachführen, kein Drift zwischen Code und Docs.

Maschinenlesbar Markdown-Dateien folgen dem llmstxt.org-Standard und können von jedem LLM direkt als Kontext geladen werden.

Einmal schreiben XML-Docs dienen gleichzeitig als IntelliSense-Tooltips in der IDE und als LLM-Kontext – keine doppelte Arbeit.

Vollständig anpassbar Das Generator-Skript ist plain PowerShell – alle Ausgabeformate, Felder und Pfade lassen sich ohne Framework-Abhängigkeit ändern.