Adjustable3D

Appearance

Dokumentations-Struktur-Leitfaden ​

Dieser Leitfaden erklärt, wie Sie Nodes für Adjustable3D dokumentieren.

Dateistruktur ​

Ihre Dokumentation folgt dieser Struktur:

adjustable3d_Documentation/
├── index.md              # Startseite
├── nodes/                # Node-Dokumentation
│   ├── _template.md      # Vorlage für neue Nodes
│   ├── categories.md     # Node-Kategorien/Index
│   └── [node-name].md    # Einzelne Node-Seiten
├── images/               # Bild-Assets
│   └── nodes/            # Node-spezifische Bilder
│       └── [node-name]-usage.png
├── guide/                # Dokumentations-Leitfäden
│   └── documentation-structure.md
└── .vitepress/           # VitePress-Konfiguration
    └── config.mjs        # Site-Konfiguration

Erstellen einer neuen Node-Dokumentation ​

Schritt 1: Vorlage kopieren ​

Kopieren Sie nodes/_template.md, um eine neue Datei mit dem Namen Ihres Nodes zu erstellen:

nodes/mein-node-name.md

Schritt 2: Frontmatter ausfüllen ​

Aktualisieren Sie am Anfang Ihrer Datei das Frontmatter:

yaml
---
title: Mein Node Name
description: Kurze Beschreibung dessen, was dieser Node macht
---

Schritt 3: Node dokumentieren ​

Füllen Sie jeden Abschnitt aus:

  1. Übersicht: Umfassende Beschreibung (2-3 Absätze)
  2. Eingaben: Tabelle mit allen Eingaben, dann detaillierte Erklärungen
  3. Ausgaben: Tabelle mit allen Ausgaben, dann detaillierte Erklärungen
  4. Beispiel-Verwendung: Bild und Beschreibung (optional)
  5. Verwandte Nodes: Links zu verwandten Nodes
  6. Siehe auch: Links zu Leitfäden und Kategorien

Schritt 4: Bilder hinzufügen (Optional) ​

Wenn Sie Beispielbilder haben:

  1. Speichern Sie das Bild als images/nodes/mein-node-name-usage.png
  2. Referenzieren Sie es in Ihrem Markdown:
markdown
![Beispiel-Verwendung von Mein Node](../images/nodes/mein-node-name-usage.png)

Schritt 5: Sidebar aktualisieren ​

Bearbeiten Sie .vitepress/config.mjs und fügen Sie Ihren Node zur Sidebar hinzu:

javascript
{
  text: 'Nodes',
  items: [
    { text: 'Node-Kategorien', link: '/nodes/kategorien' },
    { text: 'Mein Node Name', link: '/nodes/mein-node-name' }  // Dies hinzufügen
  ]
}

Node-Dokumentations-Abschnitte ​

Übersichts-Abschnitt ​

Geben Sie eine umfassende Beschreibung:

  • Was der Node macht
  • Wann man ihn verwendet
  • Häufige Anwendungsfälle
  • Wichtige Hinweise oder Einschränkungen

Eingaben-Abschnitt ​

Für jede Eingabe dokumentieren Sie:

  • Name: Der exakte Eingabename
  • Typ: Datentyp (Number, String, Vector3, etc.)
  • Beschreibung: Was die Eingabe macht
  • Standardwert: Was passiert, wenn nicht angegeben
  • Erforderlich: Ob es obligatorisch ist

Ausgaben-Abschnitt ​

Für jede Ausgabe dokumentieren Sie:

  • Name: Der exakte Ausgabename
  • Typ: Datentyp
  • Beschreibung: Was die Ausgabe liefert

Beispiel-Verwendungs-Abschnitt ​

Enthalten Sie:

  • Screenshot, der den Node in Verwendung zeigt
  • Schritt-für-Schritt-Erklärung, falls hilfreich
  • Kontext darüber, wann/warum dieses Beispiel verwendet werden sollte

Best Practices ​

  1. Konsistenz: Folgen Sie der Vorlagenstruktur für alle Nodes
  2. Klarheit: Verwenden Sie klare, prägnante Sprache
  3. Beispiele: Fügen Sie praktische Beispiele ein, wenn möglich
  4. Links: Verlinken Sie zu verwandten Nodes und Leitfäden
  5. Bilder: Verwenden Sie beschreibende Dateinamen für Bilder
  6. Formatierung: Verwenden Sie Tabellen für Eingaben/Ausgaben für einfaches Scannen

Bild-Richtlinien ​

  • Verwenden Sie PNG-Format für Screenshots
  • Halten Sie Dateigrößen angemessen (< 500KB empfohlen)
  • Verwenden Sie beschreibende Dateinamen: node-name-usage.png
  • Speichern Sie alle Node-Bilder in images/nodes/

Ihre Dokumentation testen ​

  1. Starten Sie den Dev-Server: npm run dev
  2. Navigieren Sie zu Ihrer Node-Seite
  3. Überprüfen Sie Formatierung, Links und Bilder
  4. Stellen Sie sicher, dass die Sidebar-Navigation funktioniert

Hilfe benötigt? ​