typo3-docs

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+).

Jump to install

Repository: dirnbauer/typo3-skills
Last source activity: September 5, 2026 at 13:39
Detected SKILL.md language: English
Stars: 5
Forks: 0

Install options

The review-first prompt is selected by default. You can switch to a direct command or download a local copy.

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

A direct command skips the review prompt. Inspect the source before running it.

npx skills add https://github.com/dirnbauer/typo3-skills --skill typo3-docs

The command stays on one line. Scroll horizontally to inspect it before copying.

Prefer a local copy? Download the files currently available to SkillsMP.

Review the source files

Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.

File Explorer

52 files

SKILL.md

Source instructions · Read-only preview

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). A TYPO3 extension; Documentation/ may be absent.
metadata: {"author":"Netresearch DTT GmbH","version":"2.19.3","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 per docs.typo3.org standards. ## Core Workflow 0. **No `Documentation/` yet?** Copy `assets/guides.xml.dist` to `Documentation/guides.xml`; never write one from memory -- the namespace is phpDocumentor's, not TYPO3's. 1. **Run extraction first** to find gaps: ```bash scripts/extract-all.sh /path/to/extension scripts/analyze-docs.sh /path/to/extension ``` 2. Consult the matching reference 3. Use TYPO3 directives, not plain text 4. Validate: `scripts/validate_docs.sh /path/to/extension` 5. Render: `scripts/render_docs.sh /path/to/extension` > **Critical**: For "show docs", render HTML, not raw RST. ## Element Selection Guide | Content Type | Directive | |--------------|-----------| | Complete code | `literalinclude` (preferred) | | Short snippets | `code-block` with `:caption:` | | Config options | `confval` with `:type:`, `:default:` | | PHP API | `php:method::` -- `:returntype:` for nullable/union | | Notices | `note`, `tip`, `warning`, `important` | | Feature grids | `card-grid` with footer `stretched-link` | | Alternatives | `tabs` (synchronized) | | Screenshots | `figure` with `:zoom: lightbox` + border/shadow classes | ## Critical Rules Official docs are canonical; on conflict the live manual wins -- report drift (`references/canonical-sources.md`). Upstream: - **UTF-8**, **4-space** indent (no tabs), **LF**; wrap at **80 chars** where possible - **CamelCase** files, **sentence case** headings - **Permalink anchors** (`.. _label:`) before every heading - **Index.rst** in every subdirectory - **PNG/AVIF** images with `:alt:` - **PHP domain**: no `?Type`/`Type|null` in `php:method::`; use `:returntype:` NR policy: **no `mailto:`** (upstream allows it; spam/PII -- use Issues/Discussions); **.editorconfig** in `Documentation/`. Heuristic: **~250 lines** per RST, split with `toctree`; screenshots where they help (backend modules, config, workflows). ## Code Example Validation Cross-reference examples against source: grep method names in `Classes/`, compare CLI arguments with `configure()`. See `references/extraction-patterns.md`. ## Pre-Commit Checklist 1. Code blocks have `:caption:`, inline code uses proper roles 2. Screenshots exist with `:alt:` and `:zoom: lightbox` 3. `scripts/validate_docs.sh` passes, render has no warnings 4. README and Documentation/ synchronized ## References - `references/canonical-sources.md` -- topic-to-upstream map, provenance labels - `references/file-structure.md` -- layout, naming - `references/guides-xml.md` -- the guides.xml skeleton, build config, interlinks - `references/coding-guidelines.md` -- CGL deltas, .editorconfig - `references/rst-syntax.md` -- headings, punctuation pitfalls - `references/text-roles-inline-code.md` -- `:php:`, `: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` -- figures, image rules, SVG diagrams - `references/rendering.md` -- Docker commands, live preview - `references/intercept-deployment.md` -- webhook, build triggers - `references/asset-templates-guide.md` -- templates, screenshot workflow - `references/architecture-decision-records.md` -- ADR patterns - `references/documentation-coverage-analysis.md` -- coverage scoring - `references/scripts-guide.md` -- script options - `references/typo3-extension-architecture.md` -- extension layout - `references/upstream-docs-contribution.md` -- upstream docs PRs

View on GitHub

Back to search Back to installation

typo3-playwright

Use when building or repairing Playwright browser tests for TYPO3 visitor journeys, AJAX widgets, CKEditor dialogs, backend previews, editor save/reopen flows, and consent or local form submissions. Turns a component inventory into executable assertions with isolated fixtures, coverage accounting and failure traces. Does not orchestrate a CMS upgrade, implement application fixes, choose a pixel tolerance, run a WCAG programme, or deploy.

2026-09-19

typo3-upgrade-run

Plan and execute the entire DDEV-based TYPO3 project/site update from 12 or 13 to supported 14.3 LTS and prove nothing broke, with exact visitor-facing visual and behavioral parity. Use for the end-to-end core migration, visual-regression proof that nothing changed after v13/v14 work, resuming or diagnosing the evidence graph, judging whether a few shifted pixels after an upgrade are acceptable, or determining the project PHP target and ext_emconf.php removal policy. Orchestrates preflight, immutable baseline, migration, specialists, closure, and retrospective through outcome edges, resource locks, and bounded retries. Never deploys to staging or live.

2026-09-19

typo3-upgrade-migration

Execute one graph-authorized dependency, code, schema, or data migration node within a whole-site TYPO3 v12/v13 to 14.3 upgrade. Use when Baseline A is sealed for the 13.4 rung, Composer blocker resolution, Rector/Fractor pass, manual API/data migration, stored `list_type` to `CType` ordering, 14.3 rung, schema quarantine, or fixed-point reconciliation. Enforces rollback anchors, snapshots, v14-only constraints, one-cause budgets, and specialist routing. Never owns intake, baseline, final parity, deployment, or an unbounded repeat-until-green cycle.

2026-09-18

View all from this repository

typo3-docs

Source facts

Install options

Review the source files

More from this repository

More from this repository