Skill

typo3-docs

Use when creating, editing, or reviewing TYPO3 extension documentation (Documentation/*.rst, guides.xml, README.md), rendering docs with Docker, using TYPO3 RST directives, adding screenshots, deploying to docs.typo3.org, setting up TYPO3 docs webhook, publishing TYPO3 documentation via Intercept, improve docs, add screenshots, fix documentation, or docs accuracy.

From typo3-docs

Install

Run in your terminal

npx claudepluginhub netresearch/claude-code-marketplace --plugin typo3-docs

Tool Access

This skill is limited to using the following tools:

Bash(php:*) Bash(docker:*) Bash(sed:*) Bash(grep:*) Read Write Glob Grep

Supporting Assets

View in Repository

assets/AGENTS.md

checkpoints.yaml

evals/evals.json

references/architecture-decision-records.md

references/asset-templates-guide.md

references/code-structure-elements.md

references/coding-guidelines.md

references/content-directives.md

references/documentation-coverage-analysis.md

references/extraction-patterns.md

references/file-structure.md

references/guides-xml.md

references/intercept-deployment.md

references/rendering.md

references/rst-syntax.md

references/screenshots.md

references/scripts-guide.md

references/text-roles-inline-code.md

references/typo3-directives.md

references/typo3-extension-architecture.md

Skill Content

Similar Skills

context7-mcp

Fetches up-to-date documentation from Context7 for libraries and frameworks like React, Next.js, Prisma. Use for setup questions, API references, and code examples.

context7-plugin

51.4k

find-docs

Retrieves current documentation, API references, and code examples for libraries, frameworks, SDKs, CLIs, and services via Context7 CLI. Ideal for API syntax, configs, migrations, and setup queries.

context7

50.8k

context7-cli

3 files

Uses ctx7 CLI to fetch current library docs, manage AI coding skills (install/search/generate), and configure Context7 MCP for AI editors.

context7

50.8k

Stats

Stars6

Forks0

Last CommitApr 1, 2026

Actions

View Source View Plugin View on GitHub View README

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

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

.editorconfig in Documentation/, Index.rst in every directory
4-space indent, no tabs, max 80 chars
Code blocks have :caption:, inline code uses proper roles
Screenshots exist with :alt: and :zoom: lightbox
scripts/validate_docs.sh passes, render has no warnings
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