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

FileKindSize
SKILL.mdskill md5.9 KB
assets/AGENTS.mdmarkdown11.7 KB
assets/guides.xml.distother1.8 KB
checkpoints.yamlconfig43.1 KB
evals/evals.jsonconfig23.1 KB
references/architecture-decision-records.mdmarkdown6.6 KB
references/asset-templates-guide.mdmarkdown2.8 KB
references/canonical-sources.mdmarkdown6.2 KB
references/code-structure-elements.mdmarkdown7.4 KB
references/coding-guidelines.mdmarkdown7.1 KB
references/content-directives.mdmarkdown7.6 KB
references/documentation-coverage-analysis.mdmarkdown7.6 KB
references/documentation-quality-checks.mdmarkdown3.5 KB
references/extraction-patterns.mdmarkdown23.3 KB
references/file-structure.mdmarkdown7.0 KB
references/guides-xml.mdmarkdown15.9 KB
references/intercept-deployment.mdmarkdown12.5 KB
references/render-guides-development.mdmarkdown8.8 KB
references/rendering.mdmarkdown17.3 KB
references/rst-syntax.mdmarkdown10.5 KB
references/screenshots.mdmarkdown13.1 KB
references/scripts-guide.mdmarkdown3.1 KB
references/text-roles-inline-code.mdmarkdown2.5 KB
references/typo3-directives.mdmarkdown16.0 KB
references/typo3-extension-architecture.mdmarkdown17.4 KB
references/upstream-docs-contribution.mdmarkdown7.5 KB
scripts/add-agents-md.shexecutablescript2.2 KB
scripts/analyze-docs.shexecutablescript12.0 KB
scripts/check-adr-coverage.shexecutablescript778 B
scripts/check-changelog-version-coverage.shexecutablescript1.7 KB
scripts/check-confval-completeness.shexecutablescript2.1 KB
scripts/check-guides-xml-schema.shexecutablescript4.0 KB
scripts/check-guides-xml-version-sync.shexecutablescript1.9 KB
scripts/check-required-doc-sections.shexecutablescript1.6 KB
scripts/check-rst-substitutions-resolve.shexecutablescript5.4 KB
scripts/check-screenshot-freshness.shexecutablescript2.5 KB
scripts/check-settings-documented.shexecutablescript1.5 KB
scripts/check-ui-surface-screenshots.shexecutablescript2.8 KB
scripts/check-untranslated-fluid-strings.shexecutablescript1.6 KB
scripts/check-version-match.shexecutablescript624 B
scripts/extract-all.shexecutablescript4.1 KB
scripts/extract-build-configs.shexecutablescript2.8 KB
scripts/extract-composer.shexecutablescript1.9 KB
scripts/extract-extension-config.shexecutablescript5.0 KB
scripts/extract-php.shexecutablescript5.1 KB
scripts/extract-project-files.shexecutablescript2.0 KB
scripts/extract-repo-metadata.shexecutablescript4.7 KB
scripts/extraction-dir.shexecutablescript1.7 KB
scripts/json-string.shscript921 B
scripts/render_docs.shexecutablescript1.0 KB
scripts/validate_docs.shexecutablescript6.2 KB
scripts/validate_headings.pyexecutablescript4.4 KB

scripts/validate_headings.py

View on GitHub
#!/usr/bin/env -S uv run --script
# SPDX-License-Identifier: MIT
# SPDX-FileCopyrightText: Netresearch DTT GmbH
#
# /// script
# requires-python = ">=3.11"
# dependencies = []
# ///
"""
Validate TYPO3 RST heading hierarchy.

TYPO3 heading convention:
  h1: = above AND below (overline)
  h2: = below only
  h3: - below only
  h4: ~ below only
  h5: " below only
  h6: ' below only

Usage: uv run validate_headings.py <file.rst>
Exit code 0 = no issues, output contains error lines if any.
"""

import sys

EXPECTED_ORDER = ["=", "-", "~", '"', "'"]
UNDERLINE_CHARS = set(EXPECTED_ORDER + ["^", "#", "\\"])


def _is_adornment(line):
    """Return True if line is an RST adornment (all same char, length >= 3)."""
    return (
        bool(line)
        and len(line) >= 3
        and all(c == line[0] for c in line)
        and line[0] in UNDERLINE_CHARS
    )


def parse_headings(lines):
    headings = []
    i = 0
    # Track which lines are already consumed as part of an overline heading
    consumed = set()
    while i < len(lines):
        line = lines[i].rstrip()
        if _is_adornment(line) and i not in consumed:
            char = line[0]
            # Check if this is an overline (title) or underline
            if i + 2 < len(lines):
                next_line = lines[i + 1].rstrip()
                next_next = lines[i + 2].rstrip()
                if (
                    next_line
                    and not _is_adornment(next_line)
                    and _is_adornment(next_next)
                    and next_next[0] == char
                    and len(line) >= len(next_line.strip())
                    and len(next_next) >= len(next_line.strip())
                ):
                    # Overline+underline = title (h1), skip all three lines
                    headings.append(("h1", char, next_line, i + 1))
                    consumed.add(i + 2)
                    i += 3
                    continue
            # Underline only - check previous line for title text
            if i > 0 and i - 1 not in consumed:
                prev = lines[i - 1].rstrip()
                if prev and not _is_adornment(prev) and len(line) >= len(prev.strip()):
                    headings.append(("section", char, prev, i))
        i += 1
    return headings


def check_headings(headings):
    errors = []
    sections = [h for h in headings if h[0] == "section"]

    # Check 1: First section heading must use = (h2)
    if sections and sections[0][1] != "=":
        char = sections[0][1]
        title = sections[0][2]
        lineno = sections[0][3]
        errors.append(
            f'  L{lineno + 1}: "{title}" - first section heading '
            f'must use "=" (h2), not "{char}"'
        )

    # Check 2: Detect nesting violations (e.g. h4 directly under h2, skipping h3)
    depth_stack = []
    for kind, char, title, lineno in headings:
        if kind == "h1":
            depth_stack = []
            continue
        if char not in EXPECTED_ORDER:
            errors.append(
                f'  L{lineno + 1}: "{title}" uses non-standard underline char "{char}"'
            )
            continue
        char_idx = EXPECTED_ORDER.index(char)
        # Pop stack back to find where this heading fits
        while depth_stack and depth_stack[-1] >= char_idx:
            depth_stack.pop()
        # Check for skipped levels
        if depth_stack:
            parent_idx = depth_stack[-1]
            if char_idx > parent_idx + 1:
                skipped = EXPECTED_ORDER[parent_idx + 1]
                errors.append(
                    f'  L{lineno + 1}: "{title}" uses "{char}" '
                    f"(h{char_idx + 2}) directly under "
                    f'"{EXPECTED_ORDER[parent_idx]}" (h{parent_idx + 2}), '
                    f'skipping "{skipped}" (h{parent_idx + 3})'
                )
        depth_stack.append(char_idx)

    return errors


def main():
    if len(sys.argv) != 2:
        print(f"Usage: {sys.argv[0]} <file.rst>", file=sys.stderr)
        sys.exit(2)

    filepath = sys.argv[1]
    # validate_docs.sh reports a non-UTF-8 file as a warning; reading it must
    # not fail, or the caller's `set -e` ends the run at this file.
    with open(filepath, encoding="utf-8", errors="replace") as f:
        lines = f.readlines()

    headings = parse_headings(lines)
    if not headings:
        sys.exit(0)

    errors = check_headings(headings)
    for e in errors:
        print(e)


if __name__ == "__main__":
    main()
writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 322kUpdated 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: 198kUpdated 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: 119kUpdated 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