typo3-docs

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."