Skip to content

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

typo3-docs

Flagged

Use when TYPO3 extension documentation has to render on docs.typo3.org, which builds a manual from Documentation/guides.xml and reads no Settings.cfg (a single README.rst serves an extension too small for one): when an extension has no documentation yet, or when creating, editing or reviewing Documentation/*.rst, guides.xml, README.md or XLF translations, rendering docs with Docker, TYPO3 RST directives, screenshots, or XLIFF 2-space indentation (TYPO3 v14+).

TYPO3 Documentation Skill

Create and maintain TYPO3 extension documentation per docs.typo3.org standards.

Core Workflow

  1. No Documentation/ yet? Run this, do not type the file out. The namespace is the part that comes out wrong when it is written from memory -- guides.phpdoc.org and guides.typo3.org are both addresses nobody serves -- and a file in the wrong namespace is well-formed XML that renders nothing:

    mkdir -p Documentation && cat > Documentation/guides.xml <<'XML'
    <?xml version="1.0" encoding="UTF-8"?>
    <guides xmlns="https://www.phpdoc.org/guides" links-are-relative="true">
        <project title="TITLE" version="MAJOR.MINOR" release="MAJOR.MINOR.PATCH"/>
    </guides>
    XML
    grep -Fc 'xmlns="https://www.phpdoc.org/guides"' Documentation/guides.xml
    

    Settings.cfg is the file guides.xml replaced. Nothing reads it any more, so writing one leaves the extension with no rendered documentation and no error to show for it.

    The grep prints 1 when the namespace is right and 0 when it is not. Then replace TITLE and both versions. <project> carries them as attributes; an element whose text is the extension key has no title and no release. assets/guides.xml.dist holds the full file -- extension element, interlinks, build configuration -- and is the better starting point wherever the skill directory is reachable.

  2. Run extraction first to find gaps:

    scripts/extract-all.sh /path/to/extension
    scripts/analyze-docs.sh /path/to/extension
    
  3. Consult the matching reference

  4. Use TYPO3 directives, not plain text

  5. Validate: scripts/validate_docs.sh /path/to/extension

  6. Render: scripts/render_docs.sh /path/to/extension

Critical: For "show docs", render HTML, not raw RST.

Element Selection Guide

Content TypeDirective
Complete codeliteralinclude (preferred)
Short snippetscode-block with :caption:
Config optionsconfval with :type:, :default:
PHP APIphp:method:: -- :returntype: for nullable/union
Noticesnote, tip, warning, important
Feature gridscard-grid with footer stretched-link
Alternativestabs (synchronized)
Screenshotsfigure with :zoom: lightbox + border/shadow classes

Critical Rules

Official docs are canonical; on conflict the live manual wins -- report drift (references/canonical-sources.md).

Upstream:

  • UTF-8, 4-space indent (no tabs), LF; wrap at 80 chars where possible
  • CamelCase files, sentence case headings
  • Permalink anchors (.. _label:) before every heading
  • Index.rst in every subdirectory
  • PNG/AVIF images with :alt:
  • PHP domain: no ?Type/Type|null in php:method::; use :returntype:

NR policy: no mailto: (upstream allows it; spam/PII -- use Issues/Discussions); .editorconfig in Documentation/.

Heuristic: ~250 lines per RST, split with toctree; screenshots where they help (backend modules, config, workflows).

Code Example Validation

Cross-reference examples against source: grep method names in Classes/, compare CLI arguments with configure(). See references/extraction-patterns.md.

Pre-Commit Checklist

  1. Code blocks have :caption:, inline code uses proper roles
  2. Screenshots exist with :alt: and :zoom: lightbox
  3. scripts/validate_docs.sh passes, render has no warnings
  4. README and Documentation/ synchronized

References

  • references/canonical-sources.md -- topic-to-upstream map, provenance labels
  • references/file-structure.md -- layout, naming
  • references/guides-xml.md -- the guides.xml skeleton, build config, interlinks
  • references/coding-guidelines.md -- CGL deltas, .editorconfig
  • references/rst-syntax.md -- headings, punctuation pitfalls
  • references/text-roles-inline-code.md -- :php:, :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 -- figures, image rules, SVG diagrams
  • 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
  • references/upstream-docs-contribution.md -- upstream docs PRs
  • references/render-guides-development.md -- changing the renderer itself: directive options, interlink parsing, integration-fixture semantics, Composer updates, commit and ADR conventions of TYPO3-Documentation repositories
writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 319kUpdated Claude CodeCodexVerifiedInstall
xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.Stars: 197kUpdated Claude CodeCodexVerifiedInstall
shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.Stars: 118kUpdated Claude CodeCodexVerifiedInstall
childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release.Stars: 118kUpdated Claude CodeCodexVerifiedInstall