chore(docs): add design md file - #195
Merged
Merged
Conversation
github-actions
Bot
added
scope(ci)
scope(internals)
scope(docs)
dependencies
📝 WalkthroughWalkthroughThe PR adds a generated NVIDIA Elements ChangesDESIGN.md delivery
Estimated code review effort: 3 (Moderate) | ~20 minutes Sequence Diagram(s)sequenceDiagram
participant DesignPackage
participant Eleventy
participant designMdPlugin
participant PublicSite
DesignPackage->>DesignPackage: build dist/DESIGN.md
Eleventy->>designMdPlugin: run eleventy.before hook
designMdPlugin->>PublicSite: copy DESIGN.md to public output
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
projects/site/eleventy.config.jsESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox. projects/site/package.jsonESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox. projects/site/src/_11ty/layouts/common.jsESLint skipped: the ESLint configuration for this file references a package that is not available in the sandbox.
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: 3
🤖 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/internals/design/package.json`:
- Around line 51-59: Update the sync:root task’s output declaration to
../../../DESIGN.md so it matches the artifact written by its command, while
leaving the existing command and inputs unchanged.
In `@projects/internals/design/src/design-md.js`:
- Line 203: Update the Markdown sentence near the llms.txt link to use the
complete phrasing “All APIs are available in [llms.txt](...)”, preserving the
existing link target and technical writing style.
- Around line 65-88: Update resolveTokenValue’s scale-expression branch to add
the current tokenName to resolving before recursively resolving product[1], then
remove it after resolution while preserving the existing circular-reference
error behavior. Ensure cycles involving scale expressions are detected without
affecting non-cyclic token resolution.
🪄 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: 6ee985f5-ce59-4a8f-9faf-78382cecfe61
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (20)
.vale.iniDESIGN.mdREADME.mdpackage.jsonpnpm-workspace.yamlprojects/internals/design/README.mdprojects/internals/design/eslint.config.jsprojects/internals/design/package.jsonprojects/internals/design/scripts/write-design-md.jsprojects/internals/design/src/design-md.jsprojects/internals/design/src/design-md.test.jsprojects/site/eleventy.config.jsprojects/site/package.jsonprojects/site/src/_11ty/layouts/common.jsprojects/site/src/_11ty/layouts/metadata.test.tsprojects/site/src/_11ty/plugins/design-md.jsprojects/site/src/_11ty/plugins/sitemap-xml.jsprojects/site/src/_11ty/plugins/sitemap-xml.test.tsprojects/site/src/docs/design-md/index.mdprojects/site/src/index.md
johnyanarella
approved these changes
Jul 28, 2026
- Create DESIGN.md with structured content for design tokens and guidelines. - Update .vale.ini to include DESIGN.md for style checks. - Modify package.json and pnpm-workspace.yaml to include design project paths. - Implement build scripts and ESLint configuration for the design project. - Enhance site navigation and metadata to link to DESIGN.md. Signed-off-by: Cory Rylan <crylan@nvidia.com>
coryrylan
force-pushed
the
topic-design-md
branch
from
July 28, 2026 21:18
635493b to
5fe2142
Compare
There was a problem hiding this comment.
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 @.vale.ini:
- Around line 24-26: Update the [DESIGN.md] Vale configuration to remove the
empty BasedOnStyles override, restoring inherited Vale styles and repository
writing checks; only retain an override if DESIGN.md is generated and the
configuration documents a justified exception with dedicated validation.
🪄 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: 7ef000e8-9ba0-4578-8100-ce04ce7dc4b7
⛔ Files ignored due to path filters (1)
pnpm-lock.yamlis excluded by!**/pnpm-lock.yaml
📒 Files selected for processing (20)
.vale.iniDESIGN.mdREADME.mdpackage.jsonpnpm-workspace.yamlprojects/internals/design/README.mdprojects/internals/design/eslint.config.jsprojects/internals/design/package.jsonprojects/internals/design/scripts/write-design-md.jsprojects/internals/design/src/design-md.jsprojects/internals/design/src/design-md.test.jsprojects/site/eleventy.config.jsprojects/site/package.jsonprojects/site/src/_11ty/layouts/common.jsprojects/site/src/_11ty/layouts/metadata.test.tsprojects/site/src/_11ty/plugins/design-md.jsprojects/site/src/_11ty/plugins/sitemap-xml.jsprojects/site/src/_11ty/plugins/sitemap-xml.test.tsprojects/site/src/docs/design-md/index.mdprojects/site/src/index.md
Collaborator
Author
|
🎉 This issue has been resolved in version 2.1.8 🎉 |
Collaborator
Author
|
🎉 This issue has been resolved in version 2.2.2 🎉 |
Collaborator
Author
|
🎉 This issue has been resolved in version 2.1.2 🎉 |
Collaborator
Author
|
🎉 This issue has been resolved in version 2.3.0 🎉 |
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
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
DESIGN.mdfor NVIDIA Elements, covering design tokens, UI/component guidance, accessibility, and layout/elevation conventions.DESIGN.md, including download and repository links.DESIGN.mdinto navigation, sitemap indexing, and page-specific Markdown alternate link handling.DESIGN.mdfrom the README.DESIGN.mdmatches the generator output.