Skip to content

chore(skills): add prose components definition#6423

Merged
benjamincanac merged 2 commits into
v4from
feat/skills-prose-components
May 5, 2026
Merged

chore(skills): add prose components definition#6423
benjamincanac merged 2 commits into
v4from
feat/skills-prose-components

Conversation

@larbish
Copy link
Copy Markdown
Collaborator

@larbish larbish commented May 5, 2026

Improve skills for prose components.

Usage in comarkdown/comark#172

@larbish larbish requested a review from benjamincanac as a code owner May 5, 2026 15:41
@github-actions github-actions Bot added the v4 #4488 label May 5, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 5, 2026

📝 Walkthrough

Walkthrough

Updated project docs and config for Nuxt UI Prose/Markdown rendering: (1) added .history under a new # VSC section in .gitignore; (2) added a "Render markdown" routing entry in skills/nuxt-ui/SKILL.md referencing component-selection, components, and docs; (3) added "Prose — Base Typography" and "Prose — Feature Components" sections to skills/nuxt-ui/references/components.md describing how Markdown maps to Prose components and listing feature components and callout shorthands; (4) inserted a ## Markdown guidance section in skills/nuxt-ui/references/guidelines/component-selection.md with a decision table and rendering rules.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly relates to the main changeset, which adds comprehensive prose components documentation and definitions across multiple skill files.
Description check ✅ Passed The description is relevant to the changeset, mentioning improvements to skills for prose components and providing a usage reference.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feat/skills-prose-components

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

❤️ Share

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

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a 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

🧹 Nitpick comments (1)
skills/nuxt-ui/SKILL.md (1)

86-86: ⚡ Quick win

Route “Render markdown” to the prose component index as well.

Line 86 currently maps to component-selection, docs, but this PR’s new prose component catalog lives in references/components.md; including components here makes the routing table directly actionable for component lookup.

Suggested edit
-| Render markdown | component-selection, docs |
+| Render markdown | component-selection, components |
🤖 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 `@skills/nuxt-ui/SKILL.md` at line 86, Update the routing table row for "Render
markdown" so it includes the prose component catalog tag; locate the table row
containing the text "Render markdown" (currently mapping to
"component-selection, docs") and add "components" to the comma-separated list so
the entry becomes "component-selection, docs, components"; ensure spacing and
punctuation match the surrounding table format.
🤖 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 `@skills/nuxt-ui/references/guidelines/component-selection.md`:
- Line 88: Update the sentence to use "Markdown" with a capital M for
consistency; specifically change the lowercase "markdown" in the sentence
referencing Comark/ComarkRenderer and Prose components (mentions of Comark,
<ComarkRenderer>, <Comark>, and "Prose" components) so it reads "When rendering
Markdown (for instance with Comark), **prefer Prose components**…" ensuring all
occurrences in that sentence use the capitalized term.

---

Nitpick comments:
In `@skills/nuxt-ui/SKILL.md`:
- Line 86: Update the routing table row for "Render markdown" so it includes the
prose component catalog tag; locate the table row containing the text "Render
markdown" (currently mapping to "component-selection, docs") and add
"components" to the comma-separated list so the entry becomes
"component-selection, docs, components"; ensure spacing and punctuation match
the surrounding table format.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 01f93bf3-a805-4300-b3a8-564fdf1162b7

📥 Commits

Reviewing files that changed from the base of the PR and between 6f2396f and 01e04b7.

📒 Files selected for processing (4)
  • .gitignore
  • skills/nuxt-ui/SKILL.md
  • skills/nuxt-ui/references/components.md
  • skills/nuxt-ui/references/guidelines/component-selection.md

Comment thread skills/nuxt-ui/references/guidelines/component-selection.md Outdated
@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 5, 2026

npm i https://pkg.pr.new/@nuxt/ui@6423

commit: 1507708

@benjamincanac benjamincanac changed the title feat(skills): prose components definition chore(skills): add prose components definition May 5, 2026
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a 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

🤖 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 `@skills/nuxt-ui/references/components.md`:
- Line 158: In the sentence starting "Standard Markdown elements auto-resolved
by Comark/Content/MDC..." replace the lowercase word "markdown" with the
capitalized proper noun "Markdown" for consistency; locate that sentence
(references: Comark/Content/MDC, the `::` prefix remark, and
appConfig.ui.prose.<name>) and update the casing only.
🪄 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: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d8d1f34a-8b3c-4e9b-824e-b23a33befe74

📥 Commits

Reviewing files that changed from the base of the PR and between 01e04b7 and 1507708.

📒 Files selected for processing (3)
  • skills/nuxt-ui/SKILL.md
  • skills/nuxt-ui/references/components.md
  • skills/nuxt-ui/references/guidelines/component-selection.md
✅ Files skipped from review due to trivial changes (1)
  • skills/nuxt-ui/references/guidelines/component-selection.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/nuxt-ui/SKILL.md

Comment thread skills/nuxt-ui/references/components.md
@benjamincanac benjamincanac merged commit 5b6f86c into v4 May 5, 2026
24 checks passed
@benjamincanac benjamincanac deleted the feat/skills-prose-components branch May 5, 2026 17:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

v4 #4488

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants