-
Notifications
You must be signed in to change notification settings - Fork 0
docs: sync documentation with code state #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| <!-- AUTO-GENERATED by agent-core sync. Do not edit directly. --> | ||
|
Check warning on line 1 in AGENTS.md
|
||
| # 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the link on the previous line, it's better to provide descriptive text for this URL. This improves readability.