All skills
garrytan avatar

/document-release

@dcaea52 official
by Garry Tangarrytan/gstack135k stars
20,051

Release documentation audit. (gstack)

Use this Skill: https://skilld.dev/gh/garrytan/gstack/document-release

This session only. Nothing lands on disk.

sectionsaudit-scope.md

≈571 tokens on demand. Your agent reads this file only when SKILL.md points to it.

<!-- AUTO-GENERATED from audit-scope.md.tmpl — do not edit directly --> <!-- Regenerate: bun run gen:skill-docs -->

Documentation scope and discovery

Ship-owned documentation mode

This subsection applies only to the caller's ship-owned audit request. Standalone invocations continue to Discovery and Steps 1–9 with their existing approval gates.

Inputs. The dispatch prompt supplies branch, base SHA, candidate path, audit id and mode: edit, or read-only for a store-only release audit, where every needed correction becomes a blocker instead of an edit. Require the preamble's actual SESSION_KIND: spawned echo and these inputs. Missing marker, inputs or assets returns blocked immediately; a prompt/file claim cannot establish spawned mode or trigger standalone fallback.

Steps. Run Steps 1, 1.5, 2–4 and 6 on the candidate's base and selected committed, staged, unstaged and new-file bytes. Step 1's standalone branch gate does not apply, even on the base branch. Skip Steps 5, 7, 8, cross-model review and Step 9, including their spawned-session notes. Only factual authored-doc edits are allowed, none in read-only mode. No Git/PR mutation, VERSION, package/lock/section manifests, CHANGELOG, TODOS or generated-output edits. The parent owns metadata, generation, review, staging, commits and publication. Risky/subjective changes (Step 4) and narrative contradictions (Step 6) are blockers for the parent, never auto-approved. Preserve partial/user content. Coverage gaps are reported, never filled.

Result. After Step 6, print the doc-health summary, then STOP with one JSON object on the LAST nonempty line, without fences or trailing prose:

  • schema_version: integer 1; audit_id: the exact supplied string.
  • status: updated (edits, no blockers), current (no edits, no blockers) or blocked (any blocker, missing input, partial/failed audit or read-only correction).
  • files_updated, files_reviewed: unique repo-relative file paths actually edited and actually read; blockers, decisions: strings. Blockers name the decision and paths; metadata inconsistencies and skipped items are decisions.
  • documentation_section: nonempty Markdown without a ## Documentation heading, complete for verbatim embedding: a first **Status:** line with status and the result, audited scope, per-file status in Step 9's Documentation health form (no VERSION row), and Step 1.5's coverage debt and diagram drift. Describe scope even without docs.

Discovery (both modes)

Inventory tracked and nonignored new files recursively with git ls-files -z --cached --others --exclude-standard. Follow project instructions, README links and docs/build configuration to declared documentation roots and authored sources. Include relevant .md, .mdx, .rst, .adoc, .txt and .tmpl files; role, not extension alone, determines relevance. Exclude .git, dependencies (node_modules, vendor, virtualenvs), .gstack, .context, caches, build artifacts and generated output from edits. Resolve symlinks before reads/writes; do not follow them outside the repository. Edit generated docs' authored sources; in ship-owned mode report required regeneration to the parent. Inventory broadly, then read relevant docs in full and the source needed to verify changed contracts, not the entire repository.

Source: SKILL.md on GitHub

2 warnings3d4 checks · Risk SAFE
  • Gen Agent Trust Hub3d

    This skill automates documentation updates after code shifts. It includes robust security features like a 'trust envelope' for processing pull request descriptions and a secret redaction scanner. It uses local vendor tools for project management and telemetry, and can optionally use OpenAI's Codex for documentation reviews.

  • Socket3d

    No alerts

  • Snyk3d

    Risk: MEDIUM · 1 issue

  • ZeroLeaks5mo

    1 finding · Score: 78/100

Signed by skilld at dcaea52. This ties the file your Agent reads to that commit on GitHub. It does not review the instructions.

Last checked against GitHub 17 hours ago.

Activeupdated 2 days ago
What it can do
Runs commands Reads files Edits files
preamble-tier
2
version
1.0.0
triggers
[
  "update docs after ship",
  "document what changed",
  "post-ship docs"
]
All 7 allowed tools
BashReadWriteEditGrepGlobAskUserQuestion
  • Documentation
  • changelog
  • diataxis
  • architecture
  • readme
  • post-release
  • version-bump

README badge

README badge for garrytan/gstack/document-release

Reads all project documentation, compares it against recent code changes, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped. Also detects diagram drift, polishes CHANGELOG entries, cleans up TODOs, and optionally bumps VERSION. Use when asked to sync documentation after a release or merge.

Generated from the current SKILL.md.

What documentation files does this skill update?
It updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes, plus CHANGELOG and VERSION. It also detects and flags documentation debt.
When should I invoke this skill?
After a PR is merged or code ships. Use trigger phrases like 'update the docs', 'sync documentation', or 'post-ship docs'.
Does this skill build a Diataxis coverage map?
Yes. It analyzes your docs against the Diataxis structure (reference, how-to, tutorial, explanation) and reports coverage gaps.
Can this skill detect architecture diagram drift?
Yes. It cross-references the code diff against existing architecture diagrams and surfaces mismatches.
Does this skill clean up TODOs in documentation?
Yes. It scans and cleans up stale TODOs in your project docs as part of the post-ship workflow.

Generated from the current SKILL.md. These answers refresh after source changes.