-
Notifications
You must be signed in to change notification settings - Fork 0
Enhance copy and capitalization guidelines #23
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Added guidelines for copy and capitalization, including title casing and usage of small caps.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThe AGENTS.md brand guidelines document is updated with a simplified title, new typography guidelines for copy and capitalization, Nextra theme technical notes, and expanded asset guidance emphasizing SVG icon usage over emojis. Some content sections are reiterated across the document. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
AGENTS.md(3 hunks)
🧰 Additional context used
🧠 Learnings (5)
📓 Common learnings
Learnt from: CR
Repo: raid-guild/brand PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T23:45:04.287Z
Learning: Keep the RaidGuild Agent Handbook (RG_BRAND_AGENTS.md or AGENTS.md) synchronized when design tokens, component APIs, asset locations, or setup steps change
📚 Learning: 2025-12-11T23:45:04.287Z
Learnt from: CR
Repo: raid-guild/brand PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T23:45:04.287Z
Learning: Keep the RaidGuild Agent Handbook (RG_BRAND_AGENTS.md or AGENTS.md) synchronized when design tokens, component APIs, asset locations, or setup steps change
Applied to files:
AGENTS.md
📚 Learning: 2025-12-11T23:45:04.287Z
Learnt from: CR
Repo: raid-guild/brand PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T23:45:04.287Z
Learning: Applies to **/*.{ts,tsx} : Use brand typography utility classes (type-display-lg/md/sm, type-heading-lg/md/sm, type-body-lg/md/sm, type-label, type-label-md, type-label-sm, type-code-lg/md/sm) instead of custom font sizes and weights
Applied to files:
AGENTS.md
📚 Learning: 2025-12-11T23:45:04.287Z
Learnt from: CR
Repo: raid-guild/brand PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T23:45:04.287Z
Learning: Applies to src/app/**/*.{ts,tsx} : Wrap the `<body>` element with font variables (maziusDisplay, ebGaramond, ubuntuMono) from `src/lib/fonts.ts` and the `<ThemeProvider>` from `src/lib/theme-context.tsx`
Applied to files:
AGENTS.md
📚 Learning: 2025-12-11T23:45:04.287Z
Learnt from: CR
Repo: raid-guild/brand PR: 0
File: AGENTS.md:0-0
Timestamp: 2025-12-11T23:45:04.287Z
Learning: Applies to **/*.{ts,tsx} : Follow tokens and utilities from `src/app/globals.css` and fonts from `src/lib/fonts.ts` for styling and typography
Applied to files:
AGENTS.md
🪛 LanguageTool
AGENTS.md
[grammar] ~60-~60: Ensure spelling is correct
Context: ..., flasks). the /8bit folder has special 8bit style icons for the different roles in ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🔇 Additional comments (3)
AGENTS.md (3)
39-61: Verify no unintended content duplication across document sections.The AI summary notes that "Copy & capitalization, Nextra note, and Cohort icons sections are reiterated and integrated similar sections, effectively duplicating these content blocks within the document." The provided code excerpt shows these sections appearing once (lines 39–49 and 60–61), but since old/removed lines are not displayed, confirm that these guidelines are not redundantly repeated elsewhere in the full file.
Per learnings, keep AGENTS.md synchronized with design tokens and asset locations. Duplication could obscure updates when changes are needed in the future.
1-1: Verify title simplification is intentional.The title changed from "RaidGuild Agent Handbook (Design & Brand)" to "RaidGuild Agent (Design & Brand)". While the document's purpose is still clear from line 3, confirm that removing "Handbook" was an intentional brand/messaging decision rather than an oversight.
39-48: Copy & capitalization and Nextra theme guidance looks solid.The new sections clearly document title casing conventions, small-caps avoidance, and OpenType caps feature resets for Nextra. The font-level fix (line 47) with explicit OpenType feature toggles is technically sound. Good addition for maintainability.
| - Cohort guide icon assets: this repo also exposes a subset of brand icons under `/dd` (D&D-style line icons for roles, tools, and encounters) and `public/assets/icon/magic` (magic UI glyphs like stars, crystals, lanterns, flasks). the /8bit folder has special 8bit style icons for the different roles in RaidGuild | ||
| - In documentation and MDX content, prefer these SVG icons over raw emojis. Use them via `<img src="/icon/dd/swords.svg" />` or `<img src="/icon/magic/star.svg" />` with semantic `alt` text, and avoid relying on emoji-only headings. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix capitalization error at start of sentence.
Line 60 begins with lowercase "the" after the previous sentence ends. Capitalize to "The" for proper grammar.
- Cohort guide icon assets: this repo also exposes a subset of brand icons under `/dd` (D&D-style line icons for roles, tools, and encounters) and `public/assets/icon/magic` (magic UI glyphs like stars, crystals, lanterns, flasks). the /8bit folder has special 8bit style icons for the different roles in RaidGuild
+ Cohort guide icon assets: this repo also exposes a subset of brand icons under `/dd` (D&D-style line icons for roles, tools, and encounters) and `public/assets/icon/magic` (magic UI glyphs like stars, crystals, lanterns, flasks). The /8bit folder has special 8bit style icons for the different roles in RaidGuild🧰 Tools
🪛 LanguageTool
[grammar] ~60-~60: Ensure spelling is correct
Context: ..., flasks). the /8bit folder has special 8bit style icons for the different roles in ...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
In AGENTS.md around lines 60 to 61, the second sentence begins with a lowercase
"the" ("the /8bit folder..."); change it to "The" to correct capitalization at
the start of the sentence so it reads properly ("The /8bit folder has special
8bit style icons...").
Added guidelines for copy and capitalization, including title casing and usage of small caps.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.