netresearch/typo3-docs-skill / skills/typo3-docs
typo3-docs
FlaggedUse 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+).
references/scripts-guide.md
View on GitHub<!-- SPDX-License-Identifier: CC-BY-SA-4.0 -->
<!-- SPDX-FileCopyrightText: Netresearch DTT GmbH -->
# Scripts Guide
Detailed usage for documentation extraction and analysis scripts.
`scripts/` is this skill's scripts directory. The extraction, analysis and
checkpoint scripts and `add-agents-md.sh` work on the current directory and
take no path argument: run them from the extension root. `validate_docs.sh`,
`render_docs.sh` and `check-guides-xml-schema.sh` take the project root as an
optional argument (default: the current directory).
## Documentation Extraction
To extract documentation data from all sources:
```bash
cd /path/to/extension
scripts/extract-all.sh # core sources
scripts/extract-all.sh --all # plus build configs and repository metadata
```
The results go to the extraction directory outside the project, which
`scripts/extraction-dir.sh` prints (`$DOCS_EXTRACTION_DIR` if set).
To extract from specific sources:
```bash
# Extract PHP class declarations
scripts/extract-php.sh
# Extract extension configuration (ext_emconf.php, ext_conf_template.txt)
scripts/extract-extension-config.sh
# Extract Composer metadata
scripts/extract-composer.sh
# Extract build configurations (CI, testing)
scripts/extract-build-configs.sh
# Extract project files (README, CHANGELOG)
scripts/extract-project-files.sh
# Extract repository metadata (GitHub/GitLab, through gh or glab)
scripts/extract-repo-metadata.sh
```
## Documentation Analysis
To analyze documentation coverage and identify gaps:
```bash
scripts/analyze-docs.sh # writes ANALYSIS.md into the extraction directory
```
## AI Context Setup
To add AGENTS.md template to Documentation/ folder:
```bash
scripts/add-agents-md.sh # asks before it overwrites an existing Documentation/AGENTS.md
```
## Validation and Rendering
```bash
# Validate: guides.xml renders, Index.rst exists, RST syntax (with docutils'
# rst2html), encoding, trailing whitespace, heading hierarchy
scripts/validate_docs.sh /path/to/extension
# Heading-hierarchy validation used by validate_docs.sh, one file at a time
scripts/validate_headings.py Documentation/Index.rst
# Render with the official container (output: Documentation-GENERATED-temp/)
scripts/render_docs.sh /path/to/extension
```
## Checkpoint Helpers
Invoked by `checkpoints.yaml` (see the TD-* entries); runnable standalone
from the extension root:
```bash
scripts/check-adr-coverage.sh # TD-49: ADR dir for >10-class extensions
scripts/check-changelog-version-coverage.sh # TD-48: CHANGELOG covers all git tags
scripts/check-guides-xml-version-sync.sh # TD-30: guides.xml release == ext_emconf.php, version == its major.minor
scripts/check-required-doc-sections.sh # TD-44: standard sections present
scripts/check-rst-substitutions-resolve.sh # TD-46: no |name| that only an include defines
scripts/check-untranslated-fluid-strings.sh # TD-45: hardcoded strings in Fluid templates
scripts/check-version-match.sh # the same check as check-guides-xml-version-sync.sh
```
The authoritative list is the `scripts/` directory itself — when this page
and the directory disagree, the directory wins.
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deployment | Stars: 322k | Updated | Claude CodeCodex | Verified | Install |
| 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: 198k | Updated | Claude CodeCodex | Verified | Install |
| 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: 119k | Updated | Claude CodeCodex | Verified | Install |
| 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: 118k | Updated | Claude CodeCodex | Verified | Install |