{"id":35444976,"url":"https://github.com/netresearch/typo3-docs-skill","last_synced_at":"2026-04-02T18:24:18.750Z","repository":{"id":319430635,"uuid":"1078671596","full_name":"netresearch/typo3-docs-skill","owner":"netresearch","description":"Agent Skill for creating and maintaining TYPO3 extension documentation | Claude Code compatible","archived":false,"fork":false,"pushed_at":"2026-02-15T10:27:15.000Z","size":212,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-02-15T10:31:34.596Z","etag":null,"topics":["agent-skills","ai-agent","claude-code-skill","documentation","documentation-generator","documentation-tool","open-standard","skill","typo3","typo3-cms","typo3-extension"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/netresearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-10-18T07:02:25.000Z","updated_at":"2026-02-15T10:27:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"edc65a1d-4805-47e6-8831-41e1ea30e4e4","html_url":"https://github.com/netresearch/typo3-docs-skill","commit_stats":null,"previous_names":["netresearch/typo3-docs-skill"],"tags_count":26,"template":false,"template_full_name":null,"purl":"pkg:github/netresearch/typo3-docs-skill","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Ftypo3-docs-skill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Ftypo3-docs-skill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Ftypo3-docs-skill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Ftypo3-docs-skill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/netresearch","download_url":"https://codeload.github.com/netresearch/typo3-docs-skill/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/netresearch%2Ftypo3-docs-skill/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29656589,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-20T09:27:29.698Z","status":"ssl_error","status_checked_at":"2026-02-20T09:26:12.373Z","response_time":59,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["agent-skills","ai-agent","claude-code-skill","documentation","documentation-generator","documentation-tool","open-standard","skill","typo3","typo3-cms","typo3-extension"],"created_at":"2026-01-03T01:21:58.815Z","updated_at":"2026-04-02T18:24:18.736Z","avatar_url":"https://github.com/netresearch.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# TYPO3 Documentation Skill\n\nA comprehensive Claude Code skill for creating and maintaining TYPO3 extension documentation following official TYPO3 documentation standards.\n\n## 🔌 Compatibility\n\nThis is an **Agent Skill** following the [open standard](https://agentskills.io) originally developed by Anthropic and released for cross-platform use.\n\n**Supported Platforms:**\n- ✅ Claude Code (Anthropic)\n- ✅ Cursor\n- ✅ GitHub Copilot\n- ✅ Other skills-compatible AI agents\n\n\u003e Skills are portable packages of procedural knowledge that work across any AI agent supporting the Agent Skills specification.\n\n\n## Overview\n\nThis skill provides guidance for working with TYPO3 extension documentation in reStructuredText (RST) format, including TYPO3-specific directives, local rendering with Docker, validation procedures, and automated deployment through TYPO3 Intercept.\n\n## Features\n\n- **Documentation Extraction** - Automated extraction from code, configs, and repository metadata\n- **Gap Analysis** - Identify missing and outdated documentation\n- **RST Syntax Reference** - Complete reStructuredText formatting guide\n- **TYPO3-Specific Directives** - confval, versionadded, php:method, card-grid\n- **Local Rendering** - Docker-based documentation rendering scripts\n- **Validation Tools** - RST syntax and quality check scripts\n- **Quality Standards** - Pre-commit checklists and best practices\n- **TYPO3 Intercept** - Automated deployment guidance\n- **AI Assistant Context** - AGENTS.md templates for Documentation/ folders\n\n## Installation\n\n### Marketplace (Recommended)\n\nAdd the [Netresearch marketplace](https://github.com/netresearch/claude-code-marketplace) once, then browse and install skills:\n\n```bash\n# Claude Code\n/plugin marketplace add netresearch/claude-code-marketplace\n```\n\n### npx ([skills.sh](https://skills.sh))\n\nInstall with any [Agent Skills](https://agentskills.io)-compatible agent:\n\n```bash\nnpx skills add https://github.com/netresearch/typo3-docs-skill --skill typo3-docs\n```\n\n### Download Release\n\nDownload the [latest release](https://github.com/netresearch/typo3-docs-skill/releases/latest) and extract to your agent's skills directory.\n\n### Git Clone\n\n```bash\ngit clone https://github.com/netresearch/typo3-docs-skill.git\n```\n\n### Composer (PHP Projects)\n\n```bash\ncomposer require netresearch/typo3-docs-skill\n```\n\nRequires [netresearch/composer-agent-skill-plugin](https://github.com/netresearch/composer-agent-skill-plugin).\n## Contents\n\n### SKILL.md\n\nMain skill file with comprehensive instructions for:\n- Documentation structure and workflow\n- Configuration documentation with confval\n- Version documentation with versionadded/versionchanged\n- PHP API documentation with php:method\n- Card grid navigation with stretched links\n- Cross-references and quality standards\n\n### references/\n\n**rst-syntax.md** - Complete RST syntax reference:\n- Headings, code blocks, lists, links\n- Tables, admonitions, images\n- Whitespace rules and common mistakes\n\n**typo3-directives.md** - TYPO3-specific directives:\n- confval for configuration values\n- Version directives (added/changed/deprecated)\n- PHP domain (class/method/property)\n- Card grids with stretched links\n- Intersphinx references\n- Quality checklists\n\n**extraction-patterns.md** - Documentation extraction guide:\n- Multi-source extraction patterns (PHP, configs, repository)\n- Data-to-RST mapping strategies\n- Gap analysis workflow\n- Template generation approaches\n- Quality standards for extraction\n\n**typo3-extension-architecture.md** - TYPO3 official file structure reference:\n- File structure hierarchy with priority weights\n- Directory structure weights (Classes/, Configuration/, Resources/)\n- Extraction weight matrix (Priority 1-5)\n- Quality weighting algorithm\n- Gap analysis priority calculation\n- Documentation mapping strategies\n\n### assets/\n\n**AGENTS.md** - AI assistant context template:\n- Documentation strategy and audience\n- TYPO3 RST syntax patterns\n- Directive usage examples\n- Cross-reference patterns\n- Validation and rendering procedures\n\n### scripts/\n\n**add-agents-md.sh** - Add AI context to Documentation/:\n- Creates AGENTS.md from template\n- Provides documentation context for AI assistants\n- Helps AI understand project documentation structure\n\n**validate_docs.sh** - Validation script:\n- Checks RST syntax\n- Validates Settings.cfg and Index.rst\n- Detects encoding issues\n- Identifies trailing whitespace\n\n**render_docs.sh** - Rendering script:\n- Renders documentation locally with Docker\n- Uses official TYPO3 render-guides image\n- Outputs to Documentation-GENERATED-temp/\n\n**extract-all.sh** - Documentation extraction orchestrator:\n- Extracts data from PHP code, extension configs, composer.json\n- Optional: build configs (.github/workflows, phpunit.xml)\n- Optional: repository metadata (GitHub/GitLab API)\n- Outputs to .claude/docs-extraction/data/*.json\n\n**analyze-docs.sh** - Documentation coverage analysis:\n- Compares extracted data with existing Documentation/\n- Identifies missing and outdated documentation\n- Generates Documentation/ANALYSIS.md with recommendations\n- Prioritizes action items for systematic documentation\n\n**extract-php.sh** - PHP code extraction:\n- Parses Classes/**/*.php for docblocks and signatures\n- Extracts class descriptions, methods, constants\n- Outputs to .claude/docs-extraction/data/php_apis.json\n\n**extract-extension-config.sh** - Extension configuration extraction:\n- Parses ext_emconf.php for extension metadata\n- Parses ext_conf_template.txt for configuration options\n- Identifies security warnings in config comments\n- Outputs to extension_meta.json and config_options.json\n\n**extract-composer.sh** - Composer dependency extraction:\n- Extracts requirements and dev-requirements\n- Outputs to .claude/docs-extraction/data/dependencies.json\n\n**extract-project-files.sh** - Project file extraction:\n- Extracts content from README.md, CHANGELOG.md\n- Outputs to .claude/docs-extraction/data/project_files.json\n\n**extract-build-configs.sh** - Build configuration extraction (optional):\n- Extracts CI/CD configurations, PHPUnit settings\n- Outputs to .claude/docs-extraction/data/build_configs.json\n\n**extract-repo-metadata.sh** - Repository metadata extraction (optional):\n- Fetches GitHub/GitLab repository information\n- Requires gh or glab CLI tools\n- Outputs to .claude/docs-extraction/data/repo_metadata.json\n- Cached for 24 hours\n\n## Usage\n\nThe skill automatically activates for TYPO3 documentation tasks. You can also manually invoke it:\n\n```\n/skill typo3-docs\n```\n\n### Quick Examples\n\n**Add AI Assistant Context:**\n```bash\ncd /path/to/your-extension\n~/.claude/skills/typo3-docs/scripts/add-agents-md.sh\n# Creates Documentation/AGENTS.md with TYPO3 documentation patterns\n```\n\n**Extract and Analyze Documentation:**\n```bash\ncd /path/to/your-extension\n\n# Extract data from code and configs\n~/.claude/skills/typo3-docs/scripts/extract-all.sh\n\n# Analyze documentation coverage\n~/.claude/skills/typo3-docs/scripts/analyze-docs.sh\n\n# Review the analysis report\ncat Documentation/ANALYSIS.md\n\n# Extract with optional sources\n~/.claude/skills/typo3-docs/scripts/extract-all.sh --all  # Include build configs \u0026 repo metadata\n```\n\n**Document Configuration:**\n```rst\n.. confval:: fetchExternalImages\n\n   :type: boolean\n   :Default: true\n   :Path: $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['ext_key']['setting']\n\n   Controls whether external image URLs are automatically fetched.\n```\n\n**Document Version Changes:**\n```rst\n.. versionadded:: 13.0.0\n   The CKEditor plugin now requires ``StyleUtils`` and ``GeneralHtmlSupport``\n   dependencies for style functionality.\n```\n\n**Create Card Grid Navigation:**\n```rst\n.. card-grid::\n    :columns: 1\n    :columns-md: 2\n\n    ..  card:: 📘 Introduction\n\n        Extension overview and features\n\n        ..  card-footer:: :ref:`Read more \u003cintroduction\u003e`\n            :button-style: btn btn-primary stretched-link\n```\n\n**Validate Documentation:**\n```bash\n~/.claude/skills/typo3-docs/scripts/validate_docs.sh /path/to/project\n```\n\n**Render Documentation:**\n```bash\n~/.claude/skills/typo3-docs/scripts/render_docs.sh /path/to/project\n```\n\n## Deployment Setup\n\n**Enable automatic documentation publishing to docs.typo3.org:**\n\n### Prerequisites\n1. Extension published in [TYPO3 Extension Repository (TER)](https://extensions.typo3.org/)\n2. Git repository URL referenced on TER detail page\n3. Valid Documentation/ structure with Index.rst and Settings.cfg\n\n### Quick Webhook Setup\n\n**GitHub:**\n```\nSettings → Webhooks → Add webhook\nPayload URL: https://docs-hook.typo3.org\nContent type: application/json\nSSL: Enabled\nEvents: Just the push event\nActive: ✓\n```\n\n**GitLab:**\n```\nSettings → Webhooks\nURL: https://docs-hook.typo3.org\nTriggers: Push events + Tag push events\nSSL: Enabled\n```\n\n### Verification\n\nAfter first push, check:\n- **Webhook delivery**: GitHub/GitLab webhook recent deliveries (expect `200`)\n- **Build status**: [Intercept Dashboard](https://intercept.typo3.com/admin/docs/deployments)\n- **Published docs**: `https://docs.typo3.org/p/{vendor}/{extension}/main/en-us/`\n\n**First build requires approval** by TYPO3 Documentation Team (1-3 business days). Future builds are automatic.\n\n**Full webhook setup guide:** [references/intercept-deployment.md](references/intercept-deployment.md)\n\n## Quality Standards\n\nBefore committing documentation changes, ensure:\n\n- ✅ No rendering warnings\n- ✅ No broken cross-references\n- ✅ All confval directives complete\n- ✅ Version information for new features\n- ✅ Card grids use stretched-link\n- ✅ UTF-8 emoji icons in card titles\n- ✅ Code blocks specify language\n- ✅ Proper heading hierarchy\n- ✅ No trailing whitespace\n\n## Resources\n\n**Official Documentation:**\n- [TYPO3 Documentation Guide](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/)\n- [RST Reference](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)\n- [Rendering with Docker](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/Howto/RenderingDocs/Index.html)\n\n**Example Projects:**\n- [TYPO3 Best Practice Extension](https://github.com/TYPO3BestPractices/tea)\n- [RTE CKEditor Image](https://docs.typo3.org/p/netresearch/rte-ckeditor-image/main/en-us/)\n\n**TYPO3 Intercept:**\n- [Deployment Dashboard](https://intercept.typo3.com/admin/docs/deployments)\n\n## Contributing\n\nContributions are welcome! Please follow these guidelines:\n\n1. Fork the repository\n2. Create a feature branch (`git checkout -b feature/improvement`)\n3. Make your changes\n4. Test the skill thoroughly\n5. Commit your changes (`git commit -m 'Add improvement'`)\n6. Push to the branch (`git push origin feature/improvement`)\n7. Create a Pull Request\n\n## License\n\nThis project uses split licensing:\n\n- **Code** (scripts, workflows, configs): [MIT](LICENSE-MIT)\n- **Content** (skill definitions, documentation, references): [CC-BY-SA-4.0](LICENSE-CC-BY-SA-4.0)\n\nSee the individual license files for full terms.\n## Support\n\n**Issues and Questions:**\n- GitHub Issues: [Report issues](https://github.com/netresearch/typo3-docs-skill/issues)\n- TYPO3 Slack: [#typo3-cms](https://typo3.slack.com/archives/typo3-cms)\n\n## Credits\n\nCreated by Netresearch DTT GmbH for the TYPO3 community.\n\nBased on:\n- [TYPO3 Official Documentation Standards](https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/)\n- [Anthropic Skill Creator](https://github.com/anthropics/skills/tree/main/skill-creator)\n- Real-world usage in [RTE CKEditor Image Extension](https://github.com/netresearch/t3x-rte_ckeditor_image)\n\n---\n\n**Version:** 1.0.0\n**Maintained By:** Netresearch DTT GmbH\n**Last Updated:** 2025-10-18\n\n---\n\n**Made with ❤️ for Open Source by [Netresearch](https://www.netresearch.de/)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Ftypo3-docs-skill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnetresearch%2Ftypo3-docs-skill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnetresearch%2Ftypo3-docs-skill/lists"}