docs: move the Agent Skill install into the README quickstart

[bagowix]

Summary

The Agent Skill shipped in #205 was documented under ## Using with AI coding agents, the second-to-last section of the README — below the comparison table,
the integrations list and the documentation index. For the reader it is a
quickstart: npx skills add bagowix/interlock and the agent does the wiring.
Nobody scrolls that far to find out.

## Quickstart now holds both paths:

## Quickstart
   ### With a coding agent   ← npx skills add + llms.txt / llms-full.txt / Context7
   ### By hand               ← the existing CircuitBreaker example, unchanged

The prose is moved verbatim; the only new lines are the two subsection
headings. The bottom section is gone, and nothing linked to its anchor.

docs/index.md already carried the same block high on the page (## AI coding agents, right after ## At a glance), so the docs site needs no change.

Checklist

• Tests added or updated (suite stays at 100% coverage) — N/A, no code changed
• uv run ruff format --check and uv run ruff check pass — N/A, no Python changed
• uv run mypy, uv run pyright and uv run pyrefly check pass — N/A, no Python changed
• Docs updated (docs/) for user-facing changes — docs/index.md already placed the block above the fold
• CHANGELOG.md [Unreleased] updated — the skill entry is already there from feat: ship an Agent Skill for adding breakers with coding agents #205 and still describes this accurately; this PR only moves where the README says it
• Commits follow Conventional Commits
• pymarkdown passes (pre-commit)

Related issues

Follow-up to #205.

Added

• Added coding-agent setup with npx skills add bagowix/interlock.
• Added links to llms.txt, llms-full.txt, and Context7.

Changed

• Moved Agent Skill instructions into the Quickstart section.
• Kept the existing CircuitBreaker manual setup under “By hand”.
• Removed “Using with AI coding agents”.

[coderabbitai]

Warning

Review limit reached

Next included review available in 49 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 481b9f4c-ec9f-4efa-a427-870964fd66bf

📥 Commits

Reviewing files that changed from the base of the PR and between fae05ae and caa96c1.

📒 Files selected for processing (1)

• CHANGELOG.md

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 9a731069-856b-42e9-a5a7-d1ce498ded4c

📥 Commits

Reviewing files that changed from the base of the PR and between a43b44a and fae05ae.

📒 Files selected for processing (1)

• README.md

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

📜 Recent review details

⏰ Context from checks skipped due to timeout. (10)

• GitHub Check: Docs7 PR Review
• GitHub Check: quality (3.11)
• GitHub Check: quality (3.14t)
• GitHub Check: quality (3.14)
• GitHub Check: quality (3.13)
• GitHub Check: quality (3.12)
• GitHub Check: Platform smoke (macos-latest, Python 3.14)
• GitHub Check: Platform smoke (macos-latest, Python 3.11)
• GitHub Check: Platform smoke (windows-latest, Python 3.11)
• GitHub Check: Coverage

⚠️ CI failures not shown inline (2)

GitHub Actions: Code scanning AI findings on PR #221 / 0_github-advanced-security.txt: Code scanning AI findings on PR #221

Conclusion: failure

View job details

##[group]Run set -euo pipefail
 �[36;1mset -euo pipefail�[0m
 �[36;1mecho "RUNNER_TEMP=$RUNNER_TEMP"�[0m
 �[36;1mfind "$RUNNER_TEMP" -maxdepth 1 -type f -name 'git-credentials-*.config' -print -delete�[0m
 �[36;1m�[0m
 �[36;1m# Generate a unique token and stop processing workflow commands to prevent the runtime from injecting commands�[0m
 �[36;1mSTOP_***REDACTED_SECRET_ASSIGNMENT*** /proc/sys/kernel/random/uuid)�[0m
 �[36;1m�[0m
 �[36;1m# Use a trap to ensure we always resume command processing and check for�[0m
 �[36;1m# fallback error annotations, even if the runtime exits with a non-zero code�[0m
 �[36;1m# (which would otherwise cause set -e to abort the shell before we get here).�[0m
 �[36;1m# The trap preserves the original exit code.�[0m
 �[36;1mcopilot_cleanup() {�[0m
 �[36;1m  �[0m
 �[36;1m  if [ -n "${GIT_PROXY_PID:-}" ] && kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
 �[36;1m    echo "Stopping git-proxy (pid=$GIT_PROXY_PID)..."�[0m
 �[36;1m    kill "$GIT_PROXY_PID" 2>/dev/null || true�[0m
 �[36;1m    for _ in {1..25}; do�[0m
 �[36;1m      if ! kill -0 "$GIT_PROXY_PID" 2>/dev/null; then break; fi�[0m
 �[36;1m      sleep 0.2�[0m
 �[36;1m    done�[0m
 �[36;1m    if kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
 �[36;1m      echo "git-proxy did not stop gracefully; forcing termination."�[0m
 �[36;1m      kill -KILL "$GIT_PROXY_PID" 2>/dev/null || true�[0m
 �[36;1m    fi�[0m
 �[36;1m    wait "$GIT_PROXY_PID" 2>/dev/null || true�[0m
 �[36;1m  fi�[0m
 �[36;1m  �[0m
 �[36;1m  echo "::$STOP_***REDACTED_SECRET_ASSIGNMENT***
 �[36;1m  FALLBACK_FILE="${RUNNER_TEMP}/copilot-fallback-error.txt"�[0m
 �[36;1m  if [ -f "$FALLBACK_FILE" ]; then�[0m
 �[36;1m    FALLBACK_MSG=$(head -c 500 "$FALLBACK_FILE" | tr -d '\n\r')�[0m
 �[36;1m    echo "::error title=Copilot Error::${FALLBACK_MSG}"�[0m

---

GitHub Actions: Code scanning AI findings on PR #221 / github-advanced-security: Code scanning AI findings on PR #221

Conclusion: failure

View job details

##[group]Run set -euo pipefail
 �[36;1mset -euo pipefail�[0m
 �[36;1mecho "RUNNER_TEMP=$RUNNER_TEMP"�[0m
 �[36;1mfind "$RUNNER_TEMP" -maxdepth 1 -type f -name 'git-credentials-*.config' -print -delete�[0m
 �[36;1m�[0m
 �[36;1m# Generate a unique token and stop processing workflow commands to prevent the runtime from injecting commands�[0m
 �[36;1mSTOP_***REDACTED_SECRET_ASSIGNMENT*** /proc/sys/kernel/random/uuid)�[0m
 �[36;1m�[0m
 �[36;1m# Use a trap to ensure we always resume command processing and check for�[0m
 �[36;1m# fallback error annotations, even if the runtime exits with a non-zero code�[0m
 �[36;1m# (which would otherwise cause set -e to abort the shell before we get here).�[0m
 �[36;1m# The trap preserves the original exit code.�[0m
 �[36;1mcopilot_cleanup() {�[0m
 �[36;1m  �[0m
 �[36;1m  if [ -n "${GIT_PROXY_PID:-}" ] && kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
 �[36;1m    echo "Stopping git-proxy (pid=$GIT_PROXY_PID)..."�[0m
 �[36;1m    kill "$GIT_PROXY_PID" 2>/dev/null || true�[0m
 �[36;1m    for _ in {1..25}; do�[0m
 �[36;1m      if ! kill -0 "$GIT_PROXY_PID" 2>/dev/null; then break; fi�[0m
 �[36;1m      sleep 0.2�[0m
 �[36;1m    done�[0m
 �[36;1m    if kill -0 "$GIT_PROXY_PID" 2>/dev/null; then�[0m
 �[36;1m      echo "git-proxy did not stop gracefully; forcing termination."�[0m
 �[36;1m      kill -KILL "$GIT_PROXY_PID" 2>/dev/null || true�[0m
 �[36;1m    fi�[0m
 �[36;1m    wait "$GIT_PROXY_PID" 2>/dev/null || true�[0m
 �[36;1m  fi�[0m
 �[36;1m  �[0m
 �[36;1m  echo "::$STOP_***REDACTED_SECRET_ASSIGNMENT***
 �[36;1m  FALLBACK_FILE="${RUNNER_TEMP}/copilot-fallback-error.txt"�[0m
 �[36;1m  if [ -f "$FALLBACK_FILE" ]; then�[0m
 �[36;1m    FALLBACK_MSG=$(head -c 500 "$FALLBACK_FILE" | tr -d '\n\r')�[0m
 �[36;1m    echo "::error title=Copilot Error::${FALLBACK_MSG}"�[0m

🧰 Additional context used

📓 Path-based instructions (1)

Document user-facing changes in English Markdown documentation and keep generated documentation mirrors synchronized.

📄 CodeRabbit inference engine (AGENTS.md)

Files:

• README.md

🔇 Additional comments (1)

README.md (1)

34-54: LGTM!

---

Walkthrough

The README moves coding-agent guidance into Quickstart, adds a manual setup subsection, and removes the former standalone coding-agent section.

Changes

Quickstart documentation

Layer / File(s)	Summary
Quickstart setup paths README.md	Quickstart now contains “With a coding agent” and “By hand” subsections. The former standalone “Using with AI coding agents” section is removed.

Priority: ⬇️ Low

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

Change: Other

Suggested labels: documentation

Merge Risk: ⚪ Minimal · up to fae05

This documentation-only update is ready to merge with no identified production or workflow risk.

🚥 Pre-merge checks | ✅ 8 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Changelog Entry	⚠️ Warning	The PR is not a release preparation: its subject is docs: move the Agent Skill install into the README quickstart. The scoped diff changes README.md, which is outside the exempt paths. `CHANGELOG.…	Add a new bullet under ## [Unreleased] in CHANGELOG.md that describes the user-visible README change, such as moving the Agent Skill installation instructions into the README Quickstart section.

✅ Passed checks (8 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title uses the required docs: prefix, describes the README Quickstart change, uses imperative lowercase wording, has no trailing period, and is under 72 characters.
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.
Zero-Dependency Core	✅ Passed	PASS. The reviewed range changes only README.md. It changes no file under interlock/, no file under interlock/integrations/, pyproject.toml, or interlock/init.py. Therefore it introduces no core e…
Docs And Llm Mirror	✅ Passed	PASS: The authoritative PR diff changes only README.md. It moves and renames existing Agent Skill instructions and adds the “By hand” heading. It changes no public API under interlock/, integration, c…
Tests Accompany Behaviour Change	✅ Passed	PASS: The authoritative PR diff changes only README.md. It changes no .py file under interlock/, so the custom check's PASS condition applies. No test change is required.
Public Api Surface	✅ Passed	The reviewed range changes only README.md. There is no diff in interlock/init.py or interlock/pipeline.py, so no exported symbol was removed or had its signature changed.

Full details: Changelog Entry

Explanation

The PR is not a release preparation: its subject is docs: move the Agent Skill install into the README quickstart. The scoped diff changes README.md, which is outside the exempt paths. CHANGELOG.md has no diff; its base and head object IDs are identical. The existing Agent Skill bullet under ## [Unreleased] therefore was not gained by this PR.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Commit to this branch
• Create a new PR

🧪 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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codspeed]

Merging this PR will not alter performance

✅ 28 untouched benchmarks

---

_{Comparing docs/skill-in-quickstart (caa96c1) with main (a43b44a)}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

[context7]

Docs7 for bagowix/interlock

Result	Status	Action
Deployment	➖ Not used	—
Content review	✅ Passed. No problems found.	View findings

Commit caa96c1