How do I show the docs to others?

Render the docs to HTML and display the HTML output, not the raw RST.

What are the mandatory rules I must follow?

Follow UTF-8, 4-space indentation, 80 character line length, LF endings, CamelCase file/directory names, plus an Index.rst in every subdirectory and PNG screenshots with alt and lightbox.

Which scripts should I run for validation and rendering?

Run scripts/validate_docs.sh to validate and scripts/render_docs.sh to render the docs.

typo3-docs

npx machina-cli add skill netresearch/typo3-docs-skill/typo3-docs --openclaw

Files (1)

SKILL.md

3.8 KB

TYPO3 Documentation Skill

Create and maintain TYPO3 extension documentation following official docs.typo3.org standards.

Core Workflow

Run extraction first to identify documentation gaps:

scripts/extract-all.sh /path/to/extension
scripts/analyze-docs.sh /path/to/extension

Consult the appropriate reference file for the task
Use TYPO3-specific directives, not plain text
Validate: scripts/validate_docs.sh /path/to/extension
Render: scripts/render_docs.sh /path/to/extension
Verify rendered output and README/Documentation sync

Critical: When the user asks to "show docs", render and display HTML output, not raw RST.

Element Selection Guide

Content Type	Directive
Code (5+ lines)	`literalinclude`
Short snippets	`code-block` with `:caption:`
Config options	`confval` with `:type:`, `:default:`
PHP API	`php:class::`, `php:method::`
Notices	`note`, `tip`, `warning`, `important`
Feature grids	`card-grid`
Alternatives	`tabs` (synchronized)
Collapsible	`accordion`
Screenshots	`figure` with `:zoom: lightbox` `:class: with-border with-shadow`

Critical Rules

UTF-8, 4-space indent, 80 char line length, LF endings
CamelCase file/directory names, sentence case headings
Index.rst required in every subdirectory
PNG screenshots with :alt: and :zoom: lightbox
.editorconfig required in Documentation/
Screenshots MANDATORY for backend modules, config screens, UI workflows (see references/asset-templates-guide.md)

Pre-Commit Checklist

.editorconfig in Documentation/, Index.rst in every directory
4-space indentation, no tabs, max 80 chars
Code blocks have :caption:, inline code uses proper roles (:php:, :file:)
Screenshots exist with :alt: and :zoom: lightbox
scripts/validate_docs.sh passes, render output has no warnings
README and Documentation/ are synchronized

Reference Documentation

references/file-structure.md -- directory layout, naming conventions
references/guides-xml.md -- build configuration, interlink settings
references/coding-guidelines.md -- .editorconfig, indentation rules
references/rst-syntax.md -- headings, lists, tables, formatting
references/text-roles-inline-code.md -- :php:, :file:, :guilabel:, :ref:
references/code-structure-elements.md -- code blocks, confval, PHP domain
references/typo3-directives.md -- confval, versionadded, deprecated
references/content-directives.md -- accordion, tabs, card-grid
references/screenshots.md -- image requirements, figure directives
references/rendering.md -- Docker commands, live preview
references/intercept-deployment.md -- webhook, build triggers
references/architecture-decision-records.md -- ADR templates
references/documentation-coverage-analysis.md -- gap analysis
references/extraction-patterns.md -- automated extraction
references/typo3-extension-architecture.md -- file hierarchy
references/scripts-guide.md -- extraction and analysis scripts
references/asset-templates-guide.md -- templates, screenshot workflow

External Resources

Contributing: https://github.com/netresearch/typo3-docs-skill

Source

git clone https://github.com/netresearch/typo3-docs-skill/blob/main/skills/typo3-docs/SKILL.mdView on GitHub

Overview

Create and maintain TYPO3 extension documentation following official TYPO3 docs.typo3.org standards. It covers writing with TYPO3 directives, adding screenshots, rendering locally, and deploying to docs.typo3.org.

How This Skill Works

Follow the core workflow: run extraction scripts to identify gaps, consult the reference files, write content using TYPO3 directives, then validate and render the docs. Finally verify that the rendered HTML matches readme and documentation.

When to Use It

Creating or editing Documentation/*.rst or README.md for a TYPO3 extension
Using TYPO3-specific directives instead of plain text
Adding PNG screenshots with alt text and lightbox options
Rendering docs locally to verify output before deployment
Deploying docs to docs.typo3.org and keeping README and Documentation in sync

Quick Start

Step 1: Run scripts/extract-all.sh and scripts/analyze-docs.sh on your extension
Step 2: Write docs using TYPO3 directives and add screenshots
Step 3: Run scripts/validate_docs.sh, then scripts/render_docs.sh and verify the HTML output

Best Practices

Use UTF-8 encoding and 4-space indentation with LF endings
Name files and directories with CamelCase
Include an Index.rst in every subdirectory
Use PNG screenshots with alt text and the lightbox option
Keep README and Documentation synchronized after changes

Example Use Cases

Document a new backend module with a UI screenshot
Add configuration options for an extension using confval with type and default
Annotate PHP API sections with php:class:: and php:method:: directives
Replace plain code blocks with literalinclude and code-block directives
Render docs locally and publish to docs.typo3.org

Frequently Asked Questions

Add this skill to your agents