typo3-docs

Category: Docs & Knowledge | Uploader: netresearch | Downloads: 0 | Version: v1.0（Latest）

Use when creating, editing, or reviewing TYPO3 extension documentation (Documentation/*.rst, guides.xml, README.md, XLF translations), rendering docs with Docker, using TYPO3 RST directives, adding screenshots, deploying to docs.typo3.org, improve docs, fix documentation, or XLIFF 2-space indentation (TYPO3 v14+).

Changelog: Source: GitHub https://github.com/netresearch/typo3-docs-skill

Directory Structure

Current level: tree/main/skills/typo3-docs/

📁 assets/
- 📄 AGENTS.md 11.3 KB
📁 evals/
- 📄 evals.json 19.8 KB
📁 references/
- 📄 architecture-decision-records.md 10.1 KB
- 📄 asset-templates-guide.md 2.2 KB
- 📄 code-structure-elements.md 13.8 KB
- 📄 coding-guidelines.md 6.4 KB
- 📄 content-directives.md 11.1 KB
- 📄 documentation-coverage-analysis.md 10.1 KB
- 📄 extraction-patterns.md 24.2 KB
- 📄 file-structure.md 9.0 KB
- 📄 guides-xml.md 14.2 KB
- 📄 intercept-deployment.md 10.7 KB
- 📄 rendering.md 10.3 KB
- 📄 rst-syntax.md 13.1 KB
- 📄 screenshots.md 9.3 KB
- 📄 scripts-guide.md 1.1 KB
- 📄 text-roles-inline-code.md 7.3 KB
- 📄 typo3-directives.md 22.7 KB
- 📄 typo3-extension-architecture.md 16.2 KB
📁 scripts/
- 📄 add-agents-md.sh 2.0 KB
- 📄 analyze-docs.sh 11.7 KB
- 📄 check-adr-coverage.sh 625 B
- 📄 check-changelog-version-coverage.sh 880 B
- 📄 check-guides-xml-version-sync.sh 1.2 KB
- 📄 check-required-doc-sections.sh 1.5 KB
- 📄 check-rst-substitutions-used.sh 1.4 KB
- 📄 check-unreleased-versions.sh 537 B
- 📄 check-untranslated-fluid-strings.sh 1.6 KB
- 📄 check-version-match.sh 528 B
- 📄 extract-all.sh 4.1 KB
- 📄 extract-build-configs.sh 2.6 KB
- 📄 extract-composer.sh 1.6 KB
- 📄 extract-extension-config.sh 4.3 KB
- 📄 extract-php.sh 4.7 KB
- 📄 extract-project-files.sh 2.1 KB
- 📄 extract-repo-metadata.sh 4.3 KB
- 📄 render_docs.sh 977 B
- 📄 validate_docs.sh 4.1 KB
- 📄 validate_headings.py 4.1 KB
📄 checkpoints.yaml 13.7 KB
📄 SKILL.md 4.0 KB

SKILL.md

---
name: typo3-docs
description: "Use when creating, editing, or reviewing TYPO3 extension documentation (Documentation/*.rst, guides.xml, README.md, XLF translations), rendering docs with Docker, using TYPO3 RST directives, adding screenshots, deploying to docs.typo3.org, improve docs, fix documentation, or XLIFF 2-space indentation (TYPO3 v14+)."
license: "(MIT AND CC-BY-SA-4.0). See LICENSE-MIT and LICENSE-CC-BY-SA-4.0"
compatibility: "Requires php, docker (for rendering). TYPO3 extension with Documentation/ directory."
metadata:
  author: Netresearch DTT GmbH
  version: "2.13.1"
  repository: https://github.com/netresearch/typo3-docs-skill
allowed-tools: Bash(php:*) Bash(docker:*) Bash(sed:*) Bash(grep:*) Read Write Glob Grep
---

# TYPO3 Documentation Skill

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

## Core Workflow

1. **Run extraction first** to identify documentation gaps:
   ```bash
   scripts/extract-all.sh /path/to/extension
   scripts/analyze-docs.sh /path/to/extension
   ```
2. Consult the appropriate reference file for the task
3. Use TYPO3-specific directives, not plain text
4. Validate: `scripts/validate_docs.sh /path/to/extension`
5. Render: `scripts/render_docs.sh /path/to/extension`

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

## Element Selection Guide

| Content Type | Directive |
|--------------|-----------|
| Complete code | `literalinclude` (preferred over `code-block`) |
| Short snippets | `code-block` with `:caption:` |
| Config options | `confval` with `:name:`, `:type:`, `:default:` |
| PHP API | `php:method::` -- use `:returntype:` for nullable/union types |
| Notices | `note`, `tip`, `warning`, `important` |
| Feature grids | `card-grid` with `stretched-link` in footer |
| Alternatives | `tabs` (synchronized) |
| 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
- **Permalink anchors** (`.. _label:`) before **every** section heading
- **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
- **Max 250 lines per RST page** -- split with `toctree` if exceeded
- **No `mailto:` links** -- use GitHub Issues/Discussions URLs
- **PHP domain**: never use `?Type` or `Type|null` in `php:method::` signatures; use `:returntype:` instead

## Code Example Validation

Cross-reference code examples against extension source:
grep method names in `Classes/`, compare CLI arguments against `configure()`,
verify API signatures match. See `references/extraction-patterns.md`.

## Pre-Commit Checklist

1. `.editorconfig` in `Documentation/`, `Index.rst` in every directory
2. 4-space indent, no tabs, max 80 chars
3. Code blocks have `:caption:`, inline code uses proper roles
4. Screenshots exist with `:alt:` and `:zoom: lightbox`
5. `scripts/validate_docs.sh` passes, render has no warnings
6. README and Documentation/ are synchronized

## References

- `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/asset-templates-guide.md` -- templates, screenshot workflow

Comments 0

Latest | Hot

Please login before commenting.

Loading comments...

typo3-docs

Directory Structure

SKILL.md

Report

Notice