Zur NemoClaw-Dokumentation beitragen

Diese Anleitung erklärt, wie du NemoClaw-Dokumentation schreibst, bearbeitest und reviewst. Wenn du Code änderst, der das Nutzerverhalten beeinflusst, aktualisiere die zugehörige Dokumentation im selben PR.

Agent-Skills nutzen

Wenn du einen KI-Coding-Agenten (Cursor, Claude Code, Codex etc.) verwendest, enthält das Repository Skills, die Dokumentationsarbeit automatisieren. Probiere sie aus, bevor du von Grund auf schreibst.

Die Skills liegen in .agents/skills/ und folgen automatisch dem untenstehenden Styleguide. Bitte deinen Agenten, den Skill auszuführen — z.B. „Bring die Doku für alles seit v0.2.0 auf den neuesten Stand”.

Wann die Doku aktualisieren

Aktualisiere die Dokumentation, wenn deine Änderung:

• Einen CLI-Befehl oder ein Flag hinzufügt, entfernt oder umbenennt.
• Standardverhalten oder Konfiguration ändert.
• Ein neues Feature einführt, mit dem Nutzer interagieren.
• Einen Bug behebt, den die Doku falsch beschreibt.
• Eine API, ein Protokoll oder ein Policy-Schema ändert.

Doku lokal bauen

Baue die Doku und prüfe die Ausgabe:

make docs

Lokales Serving mit automatischem Rebuild bei Änderungen:

make docs-live

Schreibkonventionen

Format

• Doku verwendet MyST Markdown, ein Sphinx-kompatibles CommonMark-Superset.
• Jede Seite beginnt mit YAML-Frontmatter (title, description, topics, tags, content type).

Seitenstruktur

1. H1-Überschrift passend zum title.page-Wert.
2. Ein bis zwei Einleitungssätze, die beschreiben, was die Seite behandelt.
3. Abschnitte mit H2 und H3, nach Aufgabe oder Konzept gegliedert.
4. Ein „Nächste Schritte”-Abschnitt am Seitenende mit Links zu verwandten Seiten.

Styleguide

Schreibe so, als würdest du einem Kollegen etwas erklären. Direkt, spezifisch, knapp.

Ton und Stil

• Aktive Stimme verwenden. „Die CLI erstellt ein Gateway”, nicht „Ein Gateway wird von der CLI erstellt.”
• Leser mit „du” ansprechen.
• Gegenwart verwenden.
• Fakten nennen. Keine Abschwächungen wie „einfach”, „natürlich” oder „mühelos”.

Wortliste

Konsistent verwenden:

Doku-Änderungen einreichen

1. Branch gemäß Projektkonvention erstellen.
2. Änderungen vornehmen.
3. Mit make docs lokal bauen und Ausgabe prüfen.
4. PR mit docs: als Conventional-Commit-Typ öffnen.

docs: update quickstart for new onboard wizard