Kontakt
Entwicklung

TYPO3 Docs

Erstellt und prüft Dokumentation für TYPO3-Extensions. Behandelt Inhalte, Rendering und Veröffentlichung auf docs.typo3.org.

Neuestes Release v2.20.9

Installation

Wähle einen unterstützten Installationsweg. Paketumfang, Einbindung in den Agent und benötigte Laufzeitwerkzeuge können sich unterscheiden.

  1. Claude Code über diesen Marketplace 
    /plugin install typo3-docs@netresearch-claude-code-marketplace

    Zuerst den Marketplace einmal in Claude Code hinzufügen: /plugin marketplace add netresearch/claude-code-marketplace. Danach das gewünschte Plugin installieren. Einrichtung und Geltungsbereich beschreibt die Claude-Code-Anleitung Ein Plugin kann mehrere Skills und zusätzliche Bestandteile enthalten.

  2. npx Skills gezielt auswählen 
    npx skills add https://github.com/netresearch/typo3-docs-skill

    Benötigt Node.js 22.20+. Im Zielprojekt ausführen und anschließend Skills und Agents im Installer auswählen. Verwendet den skills-Installer von skills.sh Installiert Skill-Anweisungen. Zusätzliche Plugin-Hooks, Befehle und externe Laufzeitwerkzeuge werden damit nicht eingerichtet.

  3. composer require PHP-Projekt, als Paket 
    composer require netresearch/typo3-docs-skill

    Den Composer-Skill-Installer aktivieren und die Skill-Einbindung auf Nachfrage freigeben. Setzt netresearch/composer-agent-skill-plugin voraus. Erkennt freigegebene Skill-Pakete und trägt ihre Anweisungen in AGENTS.md ein. Laufzeitwerkzeuge können eine eigene Einrichtung benötigen.

  4. composer skills:add PHP-Projekt, direkte Quelle 
    composer skills:add netresearch/typo3-docs-skill

    Zuerst netresearch/composer-agent-skill-plugin installieren und aktivieren; die Skill-Einbindung der gewählten Quelle freigeben. Wird bereitgestellt von netresearch/composer-agent-skill-plugin Bezieht Quell-Repositories ohne Packagist-Paket und hält sie in composer.skills.lock fest. Laufzeitabhängigkeiten werden getrennt eingerichtet.

Wofür du das Paket einsetzt

  • Dokumentationslücken einer TYPO3-Extension bestimmen und Inhalte aufbauen.
  • Dokumentation lokal rendern, prüfen und die Veröffentlichung auf docs.typo3.org vorbereiten.

Ergebnisse und Beispiele

  • TYPO3-Dokumentation in reStructuredText, eine Lückenanalyse und Ergebnisse des lokalen Renderings oder der Validierung, je nach Auftrag.

Voraussetzungen im Projekt

  • Je nach Skript werden Bash, Git, PHP, Python, jq oder weitere im Quell-README genannte Werkzeuge benötigt; lokales Rendering verwendet Docker.
  • Für die beschriebene Intercept-Veröffentlichung: TER-Eintrag mit Git-Repository-Verweis und eine gültige Documentation-Struktur. Diese Voraussetzungen gelten für die Veröffentlichung, nicht für jede redaktionelle Arbeit.

Tags

  • development
  • typo3