feat(rules): add response-links-summary output convention - #537
Conversation
Port of a personal output convention (end a stopping turn with a trailing, grouped, fully-linked ## Links index; link referenced components by URL not bare ID). Generalized from a Uniswap/Datadog-specific memory into a portable rule matching the existing .claude/rules/ format.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📚 Documentation Check ✅Verdict: Passed No plugin files were modified, so no version bump is required. The change adds a new Claude Code rules file with no breaking changes. fail_on_missing_docs is false, so informational suggestions do not block the PR. PR #537 Documentation CheckChange summary: This PR adds a single new file Checks
Verdict: PASS — no blocking issues found. Missing Updates
✨ No Documentation Updates NeededAll documentation appears to be up to date with the code changes. 🤖 Generated by Claude Documentation Validator | Mode: |
🤖 Claude Code Review
Review SummaryThis PR adds a single new documentation file What I checked
Observations (non-blocking)
VerdictNo bugs, security issues, or correctness problems. Documentation-only addition with a clear rationale section. Links💡 Want a fresh review? Add a comment containing |
There was a problem hiding this comment.
📋 Review verdict: APPROVE
👆 The main review comment above is the source of truth for this PR review. It is automatically updated on each review cycle, so always refer to it for the most current feedback.
This formal review submission is for the verdict only.
Adds
.claude/rules/response-links-summary.md— an always-on output convention: when stopping (not asking, not mid-task), end the response with a trailing## Linksblock (grouped by type, full clickable URLs, omitted when empty), and link any referenced component by URL rather than a bare ID.Why a rule (not a skill)
This is a passive output convention with no trigger phrase — it should apply to every stopping turn, so it belongs in
.claude/rules/alongsidelinting.md/plugin-docs.md, not as a task-invoked skill. (A Stop hook could enforce it programmatically, but a hook can't author the links — guidance is the right fit, matching how it already lives as personal memory.)Generalized from personal memory
Stripped the Uniswap/Datadog-US1 and individual-name specifics; kept the portable convention (PRs / tickets / observability / docs categories, full URLs, no bare IDs).
Draft for review — happy to adjust categories/wording or convert to a hook if you'd prefer enforcement.
AI-Generated Description
What
Adds
.claude/rules/response-links-summary.md— an always-on output convention: when stopping (not asking, not mid-task), end the response with a trailing## Linksblock (grouped by type, full clickable URLs, omitted when empty), and link any referenced component by URL rather than a bare ID.Single new file under
.claude/rules/; no code or behavior changes elsewhere.Why
Readers act on these links immediately — open the PR, check the live dashboard, read the ticket. A trailing, grouped, fully-linked index turns "scroll back and reconstruct what was touched" into one glance, and avoids the common failure of citing a bare ID (
#1234, monitor name, dashboard slug) that the reader then has to hunt down.Why a rule (not a skill)
This is a passive output convention with no trigger phrase — it should apply to every stopping turn, so it belongs in
.claude/rules/alongsidelinting.md/plugin-docs.md, not as a task-invoked skill. (A Stop hook could enforce it programmatically, but a hook can't author the links — guidance is the right fit, matching how it already lives as personal memory.)Generalized from personal memory
Stripped the Uniswap/Datadog-US1 and individual-name specifics; kept the portable convention (PRs / tickets / observability / docs categories, full URLs, no bare IDs).
Changes
.claude/rules/response-links-summary.md## Linksblock, full-URL requirement, "skip the section entirely if empty" guidancepackages/plugins/version bump required.Test plan
.claude/rules/markdownlint-cli2clean on the new file## Linksblock when there are actionable links, and omit it entirely when there are noneDraft for review — happy to adjust categories/wording or convert to a hook if you'd prefer enforcement.