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/check-rst-substitutions-resolve.sh

View on GitHub
#!/usr/bin/env bash
# SPDX-License-Identifier: MIT
# SPDX-FileCopyrightText: Netresearch DTT GmbH
#
# The perl programs are single-quoted on purpose; their $ belong to perl.
# shellcheck disable=SC2016
# TD-46: a page must not use a substitution that only an included file defines.
#
# render-guides (0.40.2, the image typo3-ci-workflows' docs.yml pins, and the
# :latest of 2026-09-23) does not carry `.. |name| replace::` definitions from an
# `.. include::`d file into the including page. The page renders the literal
# text `|name|` and the log says
#   app.WARNING: No replacement was found for variable |name|
# for every include form tried (`/Includes.rst.txt`, `../Includes.rst.txt`, an
# included `.rst`). A definition on the page itself renders; so do the
# guides.xml built-ins (|release|, |version|, |project|, |today|), which are not
# defined in any include file and therefore never reported here.
#
# Only names defined in an included file are checked: any
# Documentation/**/*.rst.txt, and any file an `.. include::` names, whatever its
# suffix (an included `.rst` and an included `Shared.txt` fail the same way).
# Literal blocks, code-ish directives, comments, ``inline literals``
# and `interpreted text` are stripped first, because a substitution is not
# expanded there. Each page is judged on its own.
#
# An opening | after an odd number of backslashes is escaped: render-guides
# 0.40.2 logs no warning and renders `\|name|` as `|name|` (and `\\\|name|` as
# `\|name|`). After an even number the backslashes are literal and the
# reference stays active: `\\|name|` warns and renders `\|name|`.
set -euo pipefail

[ -d Documentation ] || exit 0

# One perl process over the whole tree (xargs could split the list, and an
# include in one batch would then not be seen in another). Definitions count
# as "included" when they sit in a *.rst.txt file or in any file that an
# `.. include::` names, resolved like render-guides does: `/x` from
# Documentation/, anything else relative to the including file.
rc=0
find Documentation \( -name '*.rst' -o -name '*.rst.txt' \) -not -path '*GENERATED*' -print0 \
  | perl -0 -MCwd=abs_path -MFile::Basename=dirname -e '
    my @files = <STDIN>;
    chomp @files;
    my $root = abs_path("Documentation");
    my (%src, %text);
    for my $file (@files) {
        open my $fh, "<", $file or next;
        local $/ = "\n";
        my @lines = <$fh>;
        close $fh;
        $text{$file} = \@lines;
        $src{abs_path($file)} = 1 if $file =~ /\.rst\.txt$/;
        for (@lines) {
            next unless /^\s*\.\.\s+include::\s+(\S+)/;
            my $t = $1;
            my $a = abs_path($t =~ m{^/} ? "$root$t" : dirname($file) . "/$t");
            $src{$a} = 1 if defined $a && -f $a;
        }
    }
    # Include targets find did not list (Shared.txt, any other suffix) are read
    # for their definitions too.
    my %have = map { (abs_path($_), 1) } keys %text;
    for my $a (grep { !$have{$_} } keys %src) {
        open my $fh, "<", $a or next;
        local $/ = "\n";
        $text{$a} = [<$fh>];
        close $fh;
    }
    my %inc;
    for my $file (keys %text) {
        next unless $src{abs_path($file)};
        for (@{ $text{$file} }) { $inc{$1} = 1 if /^\.\.\s+\|([^|]+)\|\s+\S+::/; }
    }
    exit 0 unless %inc;
    my $found = 0;
    for my $file (sort grep { /\.rst$/ } keys %text) {
        my (%local, @keep);
        my $block = -1;    # indent of the line opening a literal block, -1 = none
        for my $l (@{ $text{$file} }) {
            if ($l =~ /^\.\.\s+\|([^|]+)\|\s+\S+::/) { $local{$1} = 1; next; }
            (my $ind = $l) =~ s/^(\s*).*/length($1)/se;
            if ($block >= 0) {
                if ($l =~ /^\s*$/ || $ind > $block) { next; }
                $block = -1;
            }
            if ($l =~ /^(\s*)\.\.\s+(code-block|code|sourcecode|literalinclude|uml|raw)::/
                || ($l =~ /::\s*$/ && $l !~ /^\s*\.\.\s/)) {
                $block = length(($l =~ /^(\s*)/)[0]);
                $l =~ s/::\s*$/\n/;
                push @keep, $l if $l !~ /^\s*\.\./;
                next;
            }
            if ($l =~ /^(\s*)\.\.(\s|$)/) {
                # A comment, i.e. not a directive, target, substitution definition,
                # footnote or citation: render-guides drops its indented body.
                $block = length($1)
                    if $l !~ /^\s*\.\.\s+(?:\S+::(?:\s|$)|_|\||\[)/;
                next;
            }
            push @keep, $l;
        }
        my $text = join "", @keep;
        $text =~ s/``.*?``//gs;
        $text =~ s/`[^`]*`_{0,2}//gs;
        my %seen;
        while ($text =~ /(?:(?<![\w|\\])|(?<!\\)(?:\\\\)+\K)\|([^|\s](?:[^|]*[^|\s])?)\|(?=_{0,2}(?![\w|]))/g) {
            my $n = $1;
            next unless $inc{$n} && !$local{$n} && !$seen{$n}++;
            print "$file: |$n| is defined only in an included file and renders as literal text; define it on this page or write the value\n";
            $found = 1;
        }
    }
    exit $found;
  ' || rc=$?
# 1 is a finding. Anything else non-zero is the checker failing; it exits 2
# with the reason on stderr. automated-assessment's run-checkpoints.sh reports
# every non-zero exit of a script as `fail` and discards its output, so there
# a failed scan looks like a finding; only a direct run tells them apart.
case "$rc" in
  0) exit 0 ;;
  1) exit 1 ;;
  *) echo "check-rst-substitutions-resolve: scan failed (perl exit $rc)" >&2; exit 2 ;;
esac
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