diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..8bd71a7 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,55 @@ + +# sync-docs + +> Sync documentation with code changes. Find outdated refs, update CHANGELOG, flag stale examples. + +## Agents + +- sync-docs-agent + +## Skills + +- sync-docs + +## Commands + +- sync-docs + +## Critical Rules + +1. **Plain text output** - No emojis, no ASCII art. Use `[OK]`, `[ERROR]`, `[WARN]`, `[CRITICAL]` for status markers. +2. **No unnecessary files** - Don't create summary files, plan files, audit files, or temp docs. +3. **Task is not done until tests pass** - Every feature/fix must have quality tests. +4. **Create PRs for non-trivial changes** - No direct pushes to main. +5. **Always run git hooks** - Never bypass pre-commit or pre-push hooks. +6. **Use single dash for em-dashes** - In prose, use ` - ` (single dash with spaces), never ` -- `. +7. **Report script failures before manual fallback** - Never silently bypass broken tooling. +8. **Token efficiency** - Be concise. Save tokens over decorations. + +## Model Selection + +| Model | When to Use | +|-------|-------------| +| **Opus** | Complex reasoning, analysis, planning | +| **Sonnet** | Validation, pattern matching, most agents | +| **Haiku** | Mechanical execution, no judgment needed | + +## Core Priorities + +1. User DX (plugin users first) +2. Worry-free automation +3. Token efficiency +4. Quality output +5. Simplicity + +## Dev Commands + +```bash +npm test # Run tests +npm run validate # All validators +``` + +## References + +- Part of the [agentsys](https://github.com/agent-sh/agentsys) ecosystem +- https://agentskills.io diff --git a/CHANGELOG.md b/CHANGELOG.md index 893769a..3600f5f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## [Unreleased] + +### Added + +- Doc-drift signals from `agent-analyzer` binary: docs with low code-coupling are surfaced as likely stale +- Prompt in `sync-docs` skill to generate `repo-intel` map when not found, enabling doc-drift detection +- Pre-fetch of doc-drift data in `sync-docs` command before spawning the agent, reducing redundant binary calls + ## [1.0.0] - 2026-02-21 Initial release. Extracted from [agentsys](https://github.com/agent-sh/agentsys) monorepo.