feat: add content plugin — voice and tone agent and content review skill#109
feat: add content plugin — voice and tone agent and content review skill#109jschuler wants to merge 4 commits into
Conversation
|
Warning Review limit reached
More reviews will be available in 48 minutes and 31 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more credits in the billing tab to continue. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR introduces a new PatternFly content plugin to the ai-helpers repository. The plugin provides content design guidance—including voice/tone standards, content review workflows, and UX writing guidance—for use with Claude and Cursor. The change registers the plugin in both marketplace manifests, declares plugin metadata, updates project documentation, and includes comprehensive skill and agent guidelines. ChangesPatternFly Content Plugin
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Possibly related PRs
Suggested reviewers
🚥 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)
Warning Review ran into problems🔥 ProblemsLinked repositories: Your configuration references 1 linked repositories, but your current plan allows 0. Analyzed ``, skipped 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 |
jschuler
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@plugins/content/skills/content-review/SKILL.md`:
- Around line 1-4: Rename the skill to include the PatternFly prefix: move the
directory from skills/content-review/ to skills/pf-content-review/ and update
the SKILL.md frontmatter field name: change name: content-review to name:
pf-content-review. Then search and replace any cross-references of the old
identifier ("content-review") in marketplace.json, PLUGINS.md, and README.md to
the new identifier ("pf-content-review") and ensure any links, registry keys, or
examples use the updated directory and frontmatter name. Finally, run a quick
build or link check to verify no broken references remain.
- Around line 1-4: The skill frontmatter for the content-review skill is missing
the required flag to prevent programmatic invocation; update the YAML
frontmatter in SKILL.md for the skill named "content-review" by adding
disable-model-invocation: true (as a boolean) inside the existing --- block so
the skill cannot be invoked by the model when performing side-effecting
operations such as the "apply with the Edit tool" rewrite behavior.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 8317a2a1-068c-4d1b-b6e8-e151fd51d3c6
📒 Files selected for processing (9)
.claude-plugin/marketplace.json.cursor-plugin/marketplace.jsonPLUGINS.mdREADME.mdplugins/content/.claude-plugin/plugin.jsonplugins/content/.cursor-plugin/plugin.jsonplugins/content/README.mdplugins/content/agents/voice-and-tone.mdplugins/content/skills/content-review/SKILL.md
| --- | ||
| name: content-review | ||
| description: Audit and rewrite content to match PatternFly and Red Hat voice and tone standards. Use when contributing to patternfly.org, writing UI copy for Red Hat products, reviewing design guidelines, or editing externally sourced or AI-generated content. | ||
| --- |
There was a problem hiding this comment.
Missing pf- prefix in skill name.
The skill is PatternFly and Red Hat specific but uses content-review instead of pf-content-review. Per the coding guidelines for consumer plugins, PatternFly-specific skills must use the pf- prefix to ensure discoverability across Claude Code and Cursor.
This requires three changes:
- Rename the directory from
skills/content-review/toskills/pf-content-review/ - Update frontmatter
name:topf-content-review - Update any cross-references in marketplace.json, PLUGINS.md, and README.md
📝 Proposed fix for frontmatter
---
-name: content-review
+name: pf-content-review
description: Audit and rewrite content to match PatternFly and Red Hat voice and tone standards. Use when contributing to patternfly.org, writing UI copy for Red Hat products, reviewing design guidelines, or editing externally sourced or AI-generated content.
---📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| --- | |
| name: content-review | |
| description: Audit and rewrite content to match PatternFly and Red Hat voice and tone standards. Use when contributing to patternfly.org, writing UI copy for Red Hat products, reviewing design guidelines, or editing externally sourced or AI-generated content. | |
| --- | |
| --- | |
| name: pf-content-review | |
| description: Audit and rewrite content to match PatternFly and Red Hat voice and tone standards. Use when contributing to patternfly.org, writing UI copy for Red Hat products, reviewing design guidelines, or editing externally sourced or AI-generated content. | |
| --- |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@plugins/content/skills/content-review/SKILL.md` around lines 1 - 4, Rename
the skill to include the PatternFly prefix: move the directory from
skills/content-review/ to skills/pf-content-review/ and update the SKILL.md
frontmatter field name: change name: content-review to name: pf-content-review.
Then search and replace any cross-references of the old identifier
("content-review") in marketplace.json, PLUGINS.md, and README.md to the new
identifier ("pf-content-review") and ensure any links, registry keys, or
examples use the updated directory and frontmatter name. Finally, run a quick
build or link check to verify no broken references remain.
Source: Coding guidelines
Missing disable-model-invocation: true for side-effecting skill.
The skill writes to files in rewrite mode (line 107: "apply with the Edit tool"), which is a side effect. Per the coding guidelines and retrieved learnings, skills that perform side effects must include disable-model-invocation: true in the frontmatter to prevent the AI from invoking the skill programmatically.
🛡️ Proposed fix
---
name: content-review
description: Audit and rewrite content to match PatternFly and Red Hat voice and tone standards. Use when contributing to patternfly.org, writing UI copy for Red Hat products, reviewing design guidelines, or editing externally sourced or AI-generated content.
+disable-model-invocation: true
---🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@plugins/content/skills/content-review/SKILL.md` around lines 1 - 4, The skill
frontmatter for the content-review skill is missing the required flag to prevent
programmatic invocation; update the YAML frontmatter in SKILL.md for the skill
named "content-review" by adding disable-model-invocation: true (as a boolean)
inside the existing --- block so the skill cannot be invoked by the model when
performing side-effecting operations such as the "apply with the Edit tool"
rewrite behavior.
Sources: Coding guidelines, Learnings
|
Responding to CodeRabbit's two findings:
|
1 participant
Add
contentplugin — voice and toneSummary
contentplugin with avoice-and-toneagent and acontent-reviewskill.claude-plugin/marketplace.jsonand.cursor-plugin/marketplace.jsonPLUGINS.mdand the README plugin tableWhat this adds
voice-and-tone(agent) — Always-on knowledge of PatternFly and Red Hat content design standards, applicable to both UX microcopy and long-form documentation. Covers the four brand voice traits (friendly, approachable, collaborative, inventive), tone by context, point of view, sentence voice, capitalization, punctuation, vocabulary rules, structural patterns, component-specific microcopy (buttons, tooltips, alt text), AI language flags, and credibility principles. Sourced from patternfly.org/content-design, Red Hat brand standards, the Red Hat corporate style guide, the Red Hat Design System content accessibility guidelines, and the Writing for Red Hat takeaway guide.content-review(skill) — On-demand audit or rewrite of markdown content against PatternFly and Red Hat voice and tone rules. Accepts a file path or pasted content, produces either an annotated issues list (audit mode) or a revised version ready to apply (rewrite mode).Why a new plugin
Content design is a first-class discipline in PatternFly — the site has a dedicated content design section with grammar rules, writing guides, and brand voice documentation. None of the existing plugins cover writing and documentation quality. This fills that gap for contributors writing design guidelines, UI copy, or any content for patternfly.org or Red Hat products.
The rules are intentionally unified across both contexts: the same voice and tone standards apply to UX microcopy and long-form docs, with only minor noted exceptions (such as the ampersand rule, which is stricter in UI microcopy than in documentation).
Test plan
/plugin install content@patternfly-ai-helpersand/reload-plugins— confirmvoice-and-toneappears in agents andcontent-reviewin skills/content:content-reviewon a markdown file in audit mode — confirm it produces a numbered issues list with rule names and suggested fixes/content:content-reviewon the same file in rewrite mode — confirm it returns revised markdown and a brief change summary