agentleFS
Sign inStart free
docxologydocxology/template/.github/actions/setup-docs-lint/AGENTS.md

template / setup-docs-lint

AGENTS.md20 starsChanged 2 months agoApache-2.0View on GitHub

This composite action provisions the external tools required by the blocking documentation linter. Both Static Health Report and Documentation Lint must call this action before running scripts/audit/lint_docs.py. - actions/setup-node and actions/cache remain pinned to full SHAs. - setup-node enables cache: npm (CI-FAST-DOCSLINT-NPM-1): the npm download cache is keyed on the lockfile by the official action; npm ci semantics stay unchanged (deterministic reinstall), only tarball downloads are skipped. - Mermaid diagrams are rendered by the real mmdc command against a real…

We split this AGENTS.md into the rules it gives an agent

1 rule. About 0 are common, 0 are distinctive, and 1 is very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 1

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Run actionlint after editing this action or either caller.

    line 22

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
AGENTS.md

setup-docs-lint — technical reference

This composite action provisions the external tools required by the blocking documentation linter. Both Static Health Report and Documentation Lint must call this action before running scripts/audit/lint_docs.py.

Invariants

  • actions/setup-node and actions/cache remain pinned to full SHAs.
  • setup-node enables cache: npm (CI-FAST-DOCSLINT-NPM-1): the npm download cache is keyed on the lockfile by the official action; npm ci semantics stay unchanged (deterministic reinstall), only tarball downloads are skipped.
  • Mermaid diagrams are rendered by the real mmdc command against a real chrome-headless-shell; missing tools fail closed.
  • The resolved Chrome path is exported through GITHUB_ENV for later workflow steps in the caller job.
  • Python setup and uv sync remain caller responsibilities.

Verification

  • Run actionlint after editing this action or either caller.
  • The CI Documentation Lint and Static Health Report jobs are the real behavioral controls because the hosted-runner cache and GITHUB_ENV propagation are GitHub Actions behavior.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

Reviews can't be read right now.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free