docs(architecture): slop sweep — clear negative-framing headings + prose tells#170
Merged
Conversation
…ose tells Apply the new CLAUDE.md "Slop patterns" rules across the merged canon (found by the doc-slop-reviewer sweep; 0 blockers, structural warnings): - Negative-framing / question headings → noun phrases: README "What's here"/"What's NOT here yet" → "Contents"/"Not yet present"; PROCESS "What this file is not" → "Scope boundary" (negation list folded into one sentence); adr/README "When to write an ADR (vs. inline note)" → "ADR threshold". - 01-audience: drop the "security, compliance, and operational scale we know" adjective-triple + "we know" hedge; keep the tier-1-ceiling rationale. - 02-nfrs: drop the defensive tail "not contradictions". - adr/0001: drop the "replaced from scratch" restatement (already stated in Context); fold the rewrite-timing into the rejection clause. - adr/0000-template: "Neutral but worth noting:" → "Neutral:" (the template was seeding the banned hedge). - 03-c4-context: drop the second "visible at a glance" restatement. "## Why now" in 01-audience kept — recognized positioning-section label, body is dated fact; a noun-phrase rewrite reads worse. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (8)
WalkthroughNine single-line and multi-line documentation updates across the ChangesArchitecture Documentation Refinements
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
…sion "## Contents" matched the ai-slop-detector TOC regex (treats a literal "Contents" heading as a table of contents in a short doc). The section is a file inventory, not a TOC → "## Files in this directory". Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Applies the new
CLAUDE.md"Slop patterns" rules across the already-merged canon. Found by thedoc-slop-reviewersweep of all 13 architecture docs — 0 blockers, structural warnings only.Fixed
README.md:## What's here→## Contents;## What's NOT here yet→## Not yet presentPROCESS.md:## What this file is not→## Scope boundary(negation list → one sentence)adr/README.md:## When to write an ADR (vs. inline note)→## ADR threshold01-audience: adjective-triple "security, compliance, and operational scale we know" tightened02-nfrs: defensive tail "not contradictions" droppedadr/0001: "replaced from scratch" restatement removedadr/0000-template: "Neutral but worth noting:" → "Neutral:" (template was seeding a banned hedge)03-c4-context: duplicate "visible at a glance" removedLeft as-is
## Why nowin01-audience— recognized positioning-section label, body is all dated fact; a noun-phrase rewrite reads worse. Reviewer rated Info/low-risk.Clean (no findings)
02-trust-boundaries.md,MANIFESTO.md,glossary.md,primitives-backlog.md,04-bounded-contexts.md.🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes