agentsclimarketplace

Typo3 docs

Skill netresearch/typo3-docs-skill/skills/typo3-docs

Agent Skill for creating and maintaining TYPO3 extension documentation | Claude Code compatible

Install
npx -y skills add netresearch/typo3-docs-skill --skill typo3-docs

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

2 things to look at

  • no licenseNo license file was found in the repository. Code published without one is not open source by default, so using it at work is a question for whoever answers licensing questions where you are.
  • 7 stars7 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

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

The file declares its own license as (MIT AND CC-BY-SA-4.0). See LICENSE-MIT and LICENSE-CC-BY-SA-4.0. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

4.2 KB, 902 tokens by cl100k_base, as published. Nobody here has run it

TYPO3 Documentation Skill

Create and maintain TYPO3 extension documentation following official docs.typo3.org standards.

Core Workflow

  1. Run extraction first to identify documentation gaps: 
    scripts/extract-all.sh /path/to/extension
scripts/analyze-docs.sh /path/to/extension
  2. Consult the appropriate reference file for the task
  3. Use TYPO3-specific directives, not plain text
  4. Validate: scripts/validate_docs.sh /path/to/extension
  5. 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 TypeDirective
Complete codeliteralinclude (preferred over code-block)
Short snippetscode-block with :caption:
Config optionsconfval with :name:, :type:, :default:
PHP APIphp:method:: -- use :returntype: for nullable/union types
Noticesnote, tip, warning, important
Feature gridscard-grid with stretched-link in footer
Alternativestabs (synchronized)
Screenshotsfigure with :zoom: lightbox :class: with-border with-shadow

Critical Rules

  • UTF-8, 4-space indent, 80 char lines, LF
  • CamelCase files, sentence case headings
  • Permalink anchors (.. _label:) before every heading
  • Index.rst in every subdirectory
  • PNG screenshots with :alt: and :zoom: lightbox
  • .editorconfig in Documentation/
  • Screenshots MANDATORY for backend modules, config, workflows
  • Max 250 lines per RST -- split with toctree
  • No mailto: -- use GitHub Issues/Discussions
  • PHP domain: no ?Type/Type|null in php:method::; use :returntype:

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

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

What ships with it: 40 files

290.5 KB alongside SKILL.md, 20 of them executable

assets/

evals/

references/

scripts/

Keep looking

Skills are one crate of 327,069. Ordering is by how many stacks a row turns up in, so the top of any crate is what has actually been picked rather than what has the most stars.