project-docs

Installation
SKILL.md

Project Docs

This skill helps you keep documentation correct, minimal, and aligned with the codebase.

What To Document

  • User-facing behavior changes
  • New CLI flags, environment variables, configuration changes
  • Protocol/API changes, request/response shapes
  • Operational guidance (troubleshooting, limitations, safety workflows)

Doc Update Workflow

  1. Identify the code changes and their user-visible effects.
  2. Locate the canonical docs (README vs guides vs references).
  3. Update docs with minimal churn, matching existing style.
  4. Cross-check examples against current CLI help / code.
  5. Run relevant tests and include them in the update note.
Installs
76
GitHub Stars
6
First Seen
Feb 11, 2026
project-docs — s-hiraoku/synapse-a2a