skills.rest
netresearch
netresearchOFFICIAL
Explore all skills by this author →
Website𝕏@netresearchGitHub

typo3-docs

Create TYPO3 extension documentation in reStructuredText with official directives.

7|Updated Oct 18, 2025
Search Tags:#automation#documentation#deployment#technical writing#typo3#sphinx#rst
One-click install
npx skills add https://github.com/netresearch/typo3-docs-skill --skill typo3-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: typo3-docs
Source: https://github.com/netresearch/typo3-docs-skill/tree/main/.
Command: npx skills add https://github.com/netresearch/typo3-docs-skill --skill typo3-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires docker, gh-cli, glab-cli, docutils, and includes scripts (resource) and references (resource) components.

What problem does it solve?

TYPO3 documentation is notoriously complex, requiring specific reStructuredText (RST) syntax, TYPO3-specific directives, local rendering, rigorous validation, and automated deployment to docs.typo3.org. This Skill eliminates the manual burden, ensuring your documentation is always compliant, up-to-date, and published effortlessly. It prevents outdated content, broken links, and failed deployments, saving developers and technical writers significant time and frustration.

Core Features & Use Cases

  • Automated Documentation Extraction & Gap Analysis: Automatically scan your PHP code, configurations, and repository metadata to identify missing or outdated documentation.
    • Use Case: Quickly audit an existing TYPO3 extension to generate a prioritized report of undocumented APIs, configuration options, and missing version change logs, guiding your documentation efforts.
  • TYPO3-Specific RST Guidance & Validation: Provides comprehensive reference, examples, and validation for RST syntax and TYPO3 directives (confval, versionadded, php:method, card-grid).
    • Use Case: Ensure all configuration options are documented with correct types, defaults, and paths, and that new features are clearly marked with version information, adhering to official standards.
  • Local Rendering & Quality Assurance: Automate local documentation rendering with Docker and validate RST syntax, cross-references, and quality standards before deployment.
    • Use Case: Verify that your documentation renders perfectly, has no broken links, and meets all TYPO3 quality standards locally, preventing build failures on docs.typo3.org.
  • Streamlined Deployment Setup: Guides you through configuring webhooks for automatic publishing to docs.typo3.org via TYPO3 Intercept.
    • Use Case: Set up GitHub or GitLab webhooks to automatically publish your extension's documentation whenever you push to main or create a new version tag, ensuring continuous delivery.

Quick Start

To set up AI context for your TYPO3 extension documentation, navigate to your project root and ask the AI: "Run the add-agents-md.sh script from the typo3-docs skill to create an AGENTS.md file in my Documentation/ folder." Then, to analyze your existing documentation: "Use the typo3-docs skill to extract all documentation data from my project and analyze for gaps."

Frequently Asked Questions about typo3-docs

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

FAQPage Schema
How do I automate TYPO3 extension documentation creation and deployment?▼

Automate TYPO3 documentation by extracting API and configuration data from your PHP code, writing reStructuredText with TYPO3 directives (confval, versionadded, php:method), validating locally with Docker, and deploying via TYPO3 Intercept webhooks. This eliminates manual effort and ensures compliance with official standards.

What reStructuredText syntax and TYPO3 directives do I need for extension documentation?▼

TYPO3 documentation requires RST format with specific directives: confval for configuration options, versionadded/versionchanged for version tracking, php:method for API references, and card-grid for structured layouts. This Skill provides comprehensive guidance and validation to ensure your syntax meets TYPO3 official standards.

How do I validate TYPO3 documentation locally before publishing to docs.typo3.org?▼

Render your RST documentation locally using Docker, validate syntax and cross-references, and check for broken links and quality issues before deployment. This prevents build failures on docs.typo3.org and ensures your documentation is production-ready.

Can I identify missing or outdated documentation in my TYPO3 extension?▼

Yes. Scan your PHP code, configurations, and repository metadata to automatically detect undocumented APIs, missing configuration documentation, and outdated version information. This gap analysis guides your documentation priorities and ensures comprehensive coverage.

What do I need to set up automatic TYPO3 documentation publishing?▼

Configure GitHub or GitLab webhooks pointing to TYPO3 Intercept to trigger automatic publishing whenever you push to main or create version tags. You'll need Docker, gh-cli or glab-cli, and docutils to validate and render documentation before deployment.

Does this Skill work with existing TYPO3 extension repositories?▼

Yes. The Skill analyzes existing Documentation/*.rst files and repository structure, audits compliance with TYPO3 standards, identifies gaps, and generates templates for missing sections. It integrates with both new and established extensions.

Related Skills

Explore More Software Engineering Skills→
Dinhpham04Dinhpham04

analyze-php-source

Parse PHP/Laravel source and SQL dumps to summarize models, routes, and schemas.

Community
Intermediate
dirnbauerdirnbauer
33

typo3-docs

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

Community
Advanced
elithrarelithrar
190

gitlab

Validate GitLab remotes before executing glab CLI commands.

Community
Advanced
erbsland-deverbsland-dev

erbsland-ansi-for-sphinx

Embed static ANSI blocks in Sphinx docs using the erbsland-ansi directive.

Community
Intermediate