skills.rest
dirnbauer
dirnbauerCOMMUNITY
Explore all skills by this author →
Website𝕏@KDirnbauerGitHub

typo3-docs

Create TYPO3 extension documentation with RST and guides.xml structure.

33|6|Updated Jan 2, 2026
Search Tags:#workflow#documentation#extension#typo3#rst#render-guides
One-click install
npx skills add https://github.com/dirnbauer/webconsulting-skills --skill typo3-docs-dirnbauer
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: typo3-docs
Source: https://github.com/dirnbauer/webconsulting-skills/tree/main/skills/typo3-docs
Command: npx skills add https://github.com/dirnbauer/webconsulting-skills --skill typo3-docs-dirnbauer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill enables teams to create and maintain TYPO3 extension documentation that adheres to official docs.typo3.org standards.

Core Features & Use Cases

  • Documentation scaffolding: sets up a Documentation/ structure, guides.xml configuration, and templates for Index.rst and related pages.
  • RST & TYPO3 directives guidance: provides guidance on using ReStructuredText, confval, versionadded, and tabs.
  • Local rendering workflow: describes how to render and preview documentation locally with Docker/render-guides.

Quick Start

Start by bootstrapping the TYPO3 docs skeleton in your project and render locally using the render-guides tool. Example command: docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest init

Frequently Asked Questions about typo3-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create TYPO3 extension documentation that follows official standards?▼

To create TYPO3 extension documentation following official standards, you need to scaffold a Documentation/ directory, configure guides.xml, and write content using ReStructuredText (RST) with TYPO3-specific directives.

What is the best way to render TYPO3 RST documentation locally?▼

The best way to render TYPO3 RST documentation locally is by using the render-guides Docker image. Run the provided Docker command to initialize the project skeleton and preview your documentation output.

How do I use ReStructuredText directives like confval and versionadded in TYPO3 docs?▼

ReStructuredText directives like confval and versionadded are used in TYPO3 docs to structure configuration values and track feature additions, ensuring your extension documentation matches official formatting requirements.

Do I need Docker to preview my TYPO3 extension documentation?▼

Yes, Docker is needed to preview TYPO3 extension documentation locally. The workflow relies on the render-guides Docker image to parse your RST files and generate the final rendered output.

What files are required in a TYPO3 Documentation directory structure?▼

A TYPO3 Documentation directory requires an Index.rst file for the main content, a guides.xml configuration file for rendering settings, and any additional RST pages linked within your documentation structure.

Related Skills

Explore More Software Engineering Skills→
netresearchnetresearch
51

typo3-ddev

Automate DDEV-based TYPO3 extension environment setup with multi-version testing.

Official
Advanced
netresearchnetresearch
7

typo3-docs

Create TYPO3 extension documentation in reStructuredText with official directives.

Official
Advanced
pradyumnasagarpradyumnasagar
6

agent-handoff

Automate inter-skill data transfer and provenance capture via JSON Material Passports.

Community
Advanced
pjy4617pjy4617

manual-write

Generate structured Sphinx manuals from code, CHM, and MD sources.

Community
Advanced