Skip to content

docs: add AGENTS.md to keep skills in sync - #68

Merged
Kikobeats merged 1 commit into
masterfrom
docs/agents-md
Sep 21, 2026
Merged

Kikobeats merged 1 commit into
masterfrom
docs/agents-md

Conversation

@Kikobeats

@Kikobeats Kikobeats commented Sep 21, 2026 •

Copy link
Copy Markdown
Member

Summary

  • Add AGENTS.md mapping package changes in this repo to the matching skills in microlinkhq/skills.
  • Add CLAUDE.md as a symlink to AGENTS.md so Claude Code picks up the same notes.

Test plan

  • Confirm CLAUDE.md resolves to AGENTS.md (ls -l CLAUDE.md).
  • Confirm the package → skill table matches packages/core, packages/mcp, and the HTTP API skill.

Made with Cursor

Summary by CodeRabbit

  • Documentation
    • Added guidance for keeping product documentation synchronized with changes to methods, options, commands, tools, authentication, and plan limits.
    • Documented which reference materials should be updated when specific product areas or API behavior change.
    • Consolidated related agent guidance so documentation requirements remain consistent across supported workflows.

Co-authored-by: Cursor <cursoragent@cursor.com>
@coderabbitai

coderabbitai Bot commented Sep 21, 2026 •

Copy link
Copy Markdown

Review Change StackReview Change Stack

Understand this PR’s impact

Explore downstream dependencies and potential security impact with Blast Radius.

View blast radius →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 29252160-af33-4d49-9415-d68d8831f191

📥 Commits

Reviewing files that changed from the base of the PR and between 2f0bd17 and 183ad3f.

📒 Files selected for processing (2)
  • AGENTS.md
  • CLAUDE.md

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The change adds AGENTS.md with agent documentation synchronization rules. CLAUDE.md now links to AGENTS.md instead of being a standalone file.

Changes

Agent Documentation Governance

Layer / File(s) Summary
Documentation contract and shared entry point
AGENTS.md, CLAUDE.md
AGENTS.md defines documentation locations, source-to-skill mappings, covered API changes, and synchronization rules. CLAUDE.md becomes a symbolic link to AGENTS.md.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly summarizes the main change: adding AGENTS.md guidance to keep the repository's skills synchronized. It is concise and directly related to the changeset.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coveralls

Copy link
Copy Markdown

Coverage Report for CI Build 35575562063

Warning

No base build found for commit 2f0bd17 on master.
Coverage changes can't be calculated without a base build.
If a base build is processing, this comment will update automatically when it completes.

Coverage: 80.936%

Details

  • Patch coverage: No coverable lines changed in this PR.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

Requires a base build to compare against. How to fix this →


Coverage Stats

Coverage Status
Relevant Lines: 5732
Covered Lines: 4661
Line Coverage: 81.32%
Relevant Branches: 956
Covered Branches: 752
Branch Coverage: 78.66%
Branches in Coverage %: Yes
Coverage Strength: 27.78 hits per line

💛 - Coveralls

@Kikobeats
Kikobeats merged commit ef004aa into master Sep 21, 2026
9 checks passed
@Kikobeats
Kikobeats deleted the docs/agents-md branch September 21, 2026 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants