Skip to content

docs: add agent instruction entrypoints - #25

Closed
casper-phantom[bot] wants to merge 1 commit into
mainfrom
casper/agent-instructions-symlink
Closed

casper-phantom[bot] wants to merge 1 commit into
mainfrom
casper/agent-instructions-symlink

Conversation

@casper-phantom

@casper-phantom casper-phantom Bot commented Aug 18, 2026 •

Copy link
Copy Markdown

Note

Low risk: This documentation-only change does not alter SDK code or build configuration.

Summary

  • Add repository-specific guidance for the Rust SDK workspace and its Swift, Android, and JavaScript bridges.
  • Expose the same instructions through both standard root entrypoints by linking CLAUDE.md to canonical AGENTS.md.
  • Document only validation commands already exercised by repository CI.

Agent provenance

  • implementation: Oz — not exposed by host / not exposed by host

Casper-Issue-Key: juicebox-sdk/agent-instructions-symlink
casper-run-id: 01a015f1-7a8c-72c8-8f70-7536ff5bd926

Summary by CodeRabbit

  • Documentation
    • Added repository guidance covering the SDK’s purpose, platform layout, CI requirements, validation commands, and README locations.
    • Added a linked reference for consistent access to the repository guidance.

Co-authored-by: casper-phantom <273411261+phantom-autopilot@users.noreply.github.com>
@coderabbitai

coderabbitai Bot commented Aug 18, 2026 •

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3dac90cc-c7b5-4a04-8404-b13ce5101f83

📥 Commits

Reviewing files that changed from the base of the PR and between 6741fa6 and ec97d6a.

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

Limit details: You’ve used all 1 included review currently available under your plan. You completed 73 included PR reviews in the past 7 days; at that activity level, included reviews refill at 1 review per hour.


📝 Walkthrough

Walkthrough

Changes

Repository Guidance

Layer / File(s) Summary
Repository guidance and AI tooling link
AGENTS.md, CLAUDE.md
Added project layout, toolchain, validation, and documentation guidance. Added CLAUDE.md as a symbolic link to AGENTS.md.

Merge Risk: ⚪ Minimal · up to ec97d

This documentation-only change adds repository guidance and a linked entrypoint without changing SDK code or build configuration; no actionable merge-blocking risk remains.

🚥 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 describes the documentation change that adds repository agent instruction entrypoints.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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)
  • Create PR with unit tests
  • Commit unit tests in branch casper/agent-instructions-symlink

Usage-based review receipt

Note

This review was completed with usage-based billing: files reviewed beyond your plan's included limits are billed at $0.25/file. Track spend and usage in your billing settings.


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

@casper-phantom

Copy link
Copy Markdown
Author

Closing this rollout PR because the repository did not already have root AGENTS.md or CLAUDE.md guidance. We only want to add the reciprocal entrypoint where substantive instructions already exist.

@casper-phantom casper-phantom Bot closed this Aug 18, 2026
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.

1 participant