Skip to content

Exempt README banner alt text from the define-on-first-use rule - #7

Merged
cpitzi merged 1 commit into
mainfrom
voice/banner-alt-text
Oct 13, 2026
Merged

cpitzi merged 1 commit into
mainfrom
voice/banner-alt-text

Conversation

@cpitzi

@cpitzi cpitzi commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

Closes lentago/.github#260

CodeRabbit's markdown instruction asks for every term of art to be defined in the sentence where it first appears. During the 2026-10-12 banner rollout it flagged two taglines as they appear in README banner alt text (lentago/drosera#274, lentago/brasenia#44). lentago/.github#260 decided that those labels do not follow the rule: a tagline is a brand label of at most 58 characters, set once in brand/fleet.json and copied verbatim into every README by brand/generate.py, with no per-repo edit path, so a flag there can only be answered by a fleet-wide rename.

This adds one sentence to the **/*.md path instruction exempting the alt text of the banner line in a README header block from the define-on-first-use rule. Nothing else in the instruction changes; the rest of a README is still prose under the voice guide.

🤖 Generated with Claude Code

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Warning

This pull request changes a CodeRabbit configuration file. Because it comes from a fork or its author is not a repository collaborator, reviews use only the configuration from the target branch. The proposed configuration will take effect after it is merged.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: lentago/coderabbit/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 08595868-3804-44d2-b7eb-1bcb30254563
📥 Commits

Reviewing files that changed from the base of the PR and between 8535587 and 5289756.

📒 Files selected for processing (1)
  • .coderabbit.yaml

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 8 remain after this review.

📝 Summary

Summary by CodeRabbit

  • Documentation
    • README banner tagline text is now exempt from undefined-term warnings when it matches the repository tagline.

Walkthrough

The Markdown review instructions now exempt README banner alt text when it exactly matches the repository tagline in the generated README.

Changes

README tagline review

Layer / File(s) Summary
Add tagline exception
.coderabbit.yaml
The Markdown review instructions exempt README banner alt text that matches the repository tagline in the generated README.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~5 minutes

Change: Bug fix · Severity of issue fixed: Low

Merge Risk: ⚪ Minimal · up to 52897

The tagline source reference is consistent with the existing instructions. No change-related concern remains before merge.

Architecture Summary

Architecture risk: 🔵 Low · up to 52897

The changed surface does not map to a changed system, dependency edge, entrypoint, or external dependency.

Changed systems: None identified.

Architecture concerns
No architecture-level concerns identified.

Review details

Before / after behavior

  • observed — Modified behavior in .coderabbit.yaml: Adds a Markdown-review exception for README header banner alt text that exactly uses the repository’s brand tagline from lentago/.github/brand/generated/<repo>/readme.md.
Pre-merge checks · Passed 5
Passed Passed checks (5 passed)
Check name Status Explanation
Title check Passed The title is imperative, specific, 63 characters, and accurately describes the README banner alt-text exemption.
Description check Passed The description directly explains the rule change, its reason, scope, and linked issue.
Linked Issues check Passed Issue #260 permits either a tagline rewrite or an exemption when the taglines do not require define-on-first-use treatment. .coderabbit.yaml adds the exemption for the README header banner alt text …
Out of Scope Changes check Passed The change is limited to the **/*.md path instruction in .coderabbit.yaml. It directly implements issue #260's requested CodeRabbit exemption and does not alter tagline content, generation, or unr…
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@cpitzi
cpitzi merged commit e26d489 into main Oct 13, 2026
3 checks passed
@cpitzi
cpitzi deleted the voice/banner-alt-text branch October 13, 2026 01:03
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.

Plain-words pass on two brand taglines flagged in the banner rollout

1 participant