Repository navigation
docs(agents): hold ADR requests to the bar, and record criteria for plugin-author and developer docs - #534
Conversation
… bar Issues written before the ADR cleanup ask for "an ADR under dev-docs/adr" in their acceptance lists, and an agent following them wrote two records (bomly-cli ADR-0050 and ADR-0051) that failed the bar and were folded back into ADR-0020 and ARCHITECTURE.md in bomly-cli#531. The rule now says such a request asks for the decision to be recorded, not for a new file: the bar still decides, and a passing decision revises the live record that owns the topic first. The same section appears in both repositories and changes in both. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Warning Review limit reachedYou've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Next included review available in 20 minutes. View limit details
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. Comment |
Bomly Diff SummaryCompared Overview
Dependency Changes✅ No dependency changes. Vulnerabilities✅ No vulnerability changes. License Changes✅ No license changes. Project Posture✅ No project posture changes ( Policy Findings✅ No policy differences were identified. |
…ummary points at Both AGENTS.md summaries end by naming dev-docs/adr/README.md as the full rule, so the full rule now carries the same sentence. The CLI summary uses "code comment", the term the sentence after it already uses. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The documentation style rules cover pages under docs/. Plugin-author pages, dev-docs/ARCHITECTURE.md paragraphs and AGENTS.md summaries had no written criteria, though the existing documents already follow consistent conventions. This records those conventions: - Plugin-author pages name the SDK's public API, which rule 5 would otherwise forbid, but never a CLI-internal identifier. - An ARCHITECTURE.md paragraph that carries reasoning below the ADR bar states the rule in the present tense with its reason, with no PR chronology, and links an ADR instead of restating it. - A rule AGENTS.md summarizes changes in its full-rule document in the same pull request. - The docs link check does not cover dev-docs/ or AGENTS.md, so links there are checked by review only. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Two changes to bomly-cli's documentation guidance, combined from #534 and #535.
An ADR request is still held to the bar
dev-docs/ARCHITECTURE.md, and the pull request says so.AGENTS.md, anddev-docs/adr/README.md, which that section names as the full rule.ARCHITECTURE.mdin feat: preflight declared component requirements and disclose plugin access #531.AGENTS.mdsection is shared, so it changes together with the companion PR docs(agents): an ADR request in an issue or plan is still held to the bar bomly-sdk#122.Criteria for plugin-author and developer docs
A docs review of #531 found no written criteria for three kinds of document. These are taken from what the existing documents already do:
dev-docs/ARCHITECTURE.mdparagraphs: present tense, with the reason given beside the rule, and no chronology.AGENTS.mdsummaries: a summarized rule lands in its full document in the same pull request.It also states that links in
dev-docs/andAGENTS.mdare checked by review only.🤖 Generated with Claude Code