chore(starters): add agents files#89
Open
coryrylan wants to merge 1 commit into
Open
Conversation
📝 WalkthroughWalkthroughThis PR adds 16 AGENTS.md documentation files across starter projects, each providing framework- or build-specific integration guidance for wiring NVIDIA Elements: registration points, template/JSX/TSX syntax conventions, CSS/theme placement, SSR/hydration notes where applicable, and verification commands. ChangesStarter Framework Integration Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggested labels
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)
Comment |
![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 `@projects/starters/eleventy/AGENTS.md`:
- Line 16: Update the sentence that currently reads "Let raw `nve-*` HTML pass
through markdown only when the page intentionally owns that markup." to
capitalize the markup name so it reads "Let raw `nve-*` HTML pass through
Markdown only when the page intentionally owns that markup." — locate the exact
string in AGENTS.md and replace "markdown" with "Markdown".
In `@projects/starters/nextjs/AGENTS.md`:
- Line 1: Update the product name in the markdown heading to the canonical
“Next.js”: replace the header string "Elements NextJS Starter" with "Elements
Next.js Starter" so the title matches the rest of the document; look for the
top-level heading text "Elements NextJS Starter" in AGENTS.md and update its
capitalization/punctuation to "Next.js".
🪄 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: ASSERTIVE
Plan: Enterprise
Run ID: 8fc53f73-1ff3-44b1-8768-ca8a2f3739b8
📒 Files selected for processing (16)
projects/starters/angular/AGENTS.mdprojects/starters/bundles/AGENTS.mdprojects/starters/eleventy-ssr/AGENTS.mdprojects/starters/eleventy/AGENTS.mdprojects/starters/go/AGENTS.mdprojects/starters/hugo/AGENTS.mdprojects/starters/importmaps/AGENTS.mdprojects/starters/lit-library/AGENTS.mdprojects/starters/mpa/AGENTS.mdprojects/starters/nextjs/AGENTS.mdprojects/starters/nuxt/AGENTS.mdprojects/starters/react/AGENTS.mdprojects/starters/solidjs/AGENTS.mdprojects/starters/svelte/AGENTS.mdprojects/starters/typescript/AGENTS.mdprojects/starters/vue/AGENTS.md
Signed-off-by: Cory Rylan <crylan@nvidia.com>
coryrylan
force-pushed
the
topic-starter-skills
branch
from
0886a58 to
7c44923
Compare
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 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 `@projects/starters/nuxt/AGENTS.md`:
- Around line 8-10: Reword the adjacent bullets so they don't all start with
"Keep": change the first to something like "Retain global `htmlAttrs` for
`lang`, `nve-theme`, and `nve-transition` in `nuxt.config.ts`", the second to
"Preserve Elements Vue type references in `env.d.ts`", and the third to "Import
global Elements CSS in `app/app.vue`"; update the AGENTS.md bullets accordingly
to satisfy Vale linting while preserving the same intent and references
(`nuxt.config.ts`, `env.d.ts`, `app/app.vue`, `htmlAttrs`).
In `@projects/starters/react/AGENTS.md`:
- Around line 8-10: The three adjacent bullets all begin with "Keep", which
tripped Vale style lint; edit the AGENTS.md bullet list so the items use varied
openers (e.g., change one or two bullets to alternatives like "Place `nve-theme`
and `nve-transition` in `src/index.html`" and "Add JSX custom element type
augmentation in `src/global.d.ts`") while preserving the same file references
and intent for "Keep global theme CSS in `src/index.css`", the
`nve-theme`/`nve-transition` mention, and the JSX augmentation line.
In `@projects/starters/solidjs/AGENTS.md`:
- Around line 8-10: Adjacent bullet items that start with the same verb (e.g.,
the three bullets describing where to keep Elements JSX augmentation, global
Elements CSS, and theme attributes) should vary their opening words to satisfy
Vale lint rules; edit the bullets that reference "Elements JSX augmentation in
`src/types.d.ts`", "global Elements CSS in `src/index.css`", and "theme
attributes on `src/index.html`" to use different starters (for example, change
one "Keep" to "Place" or "Move" and another to "Store/Define") so the adjacent
bullets no longer all begin with the same word, and make the same change for the
other repeated group mentioned in the comment.
In `@projects/starters/svelte/AGENTS.md`:
- Around line 8-10: Reword one of the adjacent bullets that begin with "Keep" to
avoid repeating the same lead verb; for example, change the bullet "Keep theme
attributes on `src/index.html`" to a rephrasing such as "Place theme attributes
in `src/index.html`" or "Store theme attributes in `src/index.html`" so that the
three bullets no longer all start with "Keep" and Vale linting will pass.
In `@projects/starters/vue/AGENTS.md`:
- Around line 8-10: Reword the repeated bullet-starter words in the listed items
to avoid Vale/write-good warnings: change the three bullets that begin with
"Keep" (referencing custom-elements-vue.d.ts, env.d.ts, tsconfig.app.json and
registering elements in src/App.vue) to use varied verbs (e.g., "Reference",
"Include", "Register" or similar) and do the same for the other group at lines
15–17 so each consecutive bullet starts with a different word while preserving
the original meaning.
🪄 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: ASSERTIVE
Plan: Enterprise
Run ID: a4513fc3-203a-4c6e-a2f2-54625419726e
📒 Files selected for processing (16)
projects/starters/angular/AGENTS.mdprojects/starters/bundles/AGENTS.mdprojects/starters/eleventy-ssr/AGENTS.mdprojects/starters/eleventy/AGENTS.mdprojects/starters/go/AGENTS.mdprojects/starters/hugo/AGENTS.mdprojects/starters/importmaps/AGENTS.mdprojects/starters/lit-library/AGENTS.mdprojects/starters/mpa/AGENTS.mdprojects/starters/nextjs/AGENTS.mdprojects/starters/nuxt/AGENTS.mdprojects/starters/react/AGENTS.mdprojects/starters/solidjs/AGENTS.mdprojects/starters/svelte/AGENTS.mdprojects/starters/typescript/AGENTS.mdprojects/starters/vue/AGENTS.md
coryrylan
commented
May 18, 2026
| ## Verification | ||
|
|
||
| - Run `pnpm run build` in `projects/starters/angular` after schema, import, or template changes. | ||
| - Run `pnpm run lint` when editing TypeScript, HTML templates, or CSS. |
Collaborator
Author
There was a problem hiding this comment.
Each starter that the CLI/MCP exposes in the MR gets a AGENTS.md with minimal guidance on any elements + starter integration specific points to call out. I tried to keep these focused on the integration points as I don't want to duplicate context already provided by our mcp/cli/skills
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
1 participant
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.
Summary by CodeRabbit