Saucebox Registry
← Browse

@hoangsonww/docs-sync

A

PetSwipe documentation sync workflow for README, ARCHITECTURE, deployment docs, Kubernetes docs, and Terraform docs. Use when code or infra changes require documentation updates or when docs appear stale relative to the repository.

skillclaude

Install

agr install @hoangsonww/docs-sync --target claude

Writes 1 file into .claude/skills/, pinned to git-7f09aa27.

  • .claude/skills/docs-sync/SKILL.md

Document

name: docs-sync description: PetSwipe documentation sync workflow for README, ARCHITECTURE, deployment docs, Kubernetes docs, and Terraform docs. Use when code or infra changes require documentation updates or when docs appear stale relative to the repository.

Use this skill when documentation needs to stay aligned with the repository.

Workflow

  1. Identify the source of truth in the code or infra first.
  2. Update every doc that materially describes the changed behavior.
  3. Prefer exact commands, exact paths, and exact limitations.
  4. Remove stale claims instead of layering new text on top of them.

High-Value Targets

  • README.md
  • ARCHITECTURE.md
  • docs/DEPLOYMENT.md
  • docs/DEVOPS_GUIDE.md
  • k8s/README.md
  • terraform/README.md

Read references/doc-matrix.md to decide which docs need changes.

Trustgrade A

  • passBody integrity

    Whether the stored document is plausibly the kind of file the artifact declares, rather than something fetched by mistake.

  • passType matchnot applicable to this artifact type

    Whether the artifact is really the kind of thing its metadata claims it is.

  • passFreshness

    How long since the source repository was last pushed to.

  • passPrompt injection

    Scans the artifact's own text for instructions aimed at your agent rather than at you.

  • passLicense

    Whether the source repository declares an SPDX license permissive enough to redistribute.

How the grade is calculated

Each check contributes 0 points when it passes, 1 when it warns, and 2 when it fails. The total maps to a letter:

  • Aevery check passed
  • Bone warning
  • Ctwo warnings
  • Dprompt injection or body integrity failed, or three warnings
  • Fone of those failed, and something else is wrong

These are automated hygiene checks, not a security audit, and not a dependency or vulnerability scan. A grade of A means nothing was flagged — not that the artifact is safe.

Versions

  • git-7f09aa27b2832026-07-31