Skip to content

Commit 7f92252

Browse files
coryrylancoryrylan
committed
chore(docs): cleanup readme
Signed-off-by: Cory Rylan <crylan@nvidia.com>
1 parent cc12511 commit 7f92252

11 files changed

Lines changed: 21 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# NVIDIA Elements
22

3-
The Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
44

55
- **Agent-ready tooling:** CLI and MCP expose component APIs, tokens, examples, imports, validation, and setup to terminals and AI assistants.
66
- **Framework agnostic:** Web Components run in React, Angular, Vue, Svelte, Lit, plain HTML, server-rendered templates, and mixed stacks.

‎projects/cli/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @nvidia-elements/cli
22

3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
4+
35
The **@nvidia-elements/cli** is a dual-mode command-line tool for the Elements Design System. It provides interactive CLI commands and a Model Context Protocol (MCP) server for AI assistant integration.
46

57
## Purpose

‎projects/code/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @nvidia-elements/code
22

3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
4+
35
Syntax-highlighted code block components supporting many programming languages.
46

57
- [Documentation](https://NVIDIA.github.io/elements/docs/code/)

‎projects/core/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @nvidia-elements/core
22

3-
The design language for AI/ML factories. Provides a set of accessible, theme-ready UI elements.
3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
44

55
- [Documentation](https://NVIDIA.github.io/elements/)
66
- [Changelog](https://NVIDIA.github.io/elements/docs/changelog/)

‎projects/lint/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @nvidia-elements/lint
22

3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
4+
35
The `@nvidia-elements/lint` package is a utility library that provides Elements-specific lint rules to enforce best practices and prevent common errors when using Elements.
46

57
## Getting Started

‎projects/markdown/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @nvidia-elements/markdown
22

3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
4+
35
A Web Component for rendering markdown content with full styling support.
46

57
- [Documentation](https://NVIDIA.github.io/elements/docs/markdown/)

‎projects/media/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @nvidia-elements/media
22

3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
4+
35
Media playback UI components for Elements.
46

57
- [Documentation](https://NVIDIA.github.io/elements/)

‎projects/monaco/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @nvidia-elements/monaco
22

3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
4+
35
Integration with VS Code's Monaco editor for code editing, syntax highlighting, and diff visualization.
46

57
- [Documentation](https://NVIDIA.github.io/elements/docs/monaco/)

‎projects/site/src/index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
{
3-
title: 'NVIDIA Elements Design System for AI UI',
3+
title: 'NVIDIA Design System for AI UI',
44
description: 'NVIDIA Elements Design System: framework-agnostic Web Components, design tokens, CLI, MCP, skills, and lint tooling for AI infrastructure, robotics, and autonomous vehicle UI.',
55
layout: 'docs.11ty.js'
66
}
77
---
88

99
<div nve-layout="column gap:lg pad-top:lg">
10-
<h1 nve-text="display sm">Elements</h1>
10+
<h1 nve-text="display sm">NVIDIA Elements</h1>
1111
<h2 nve-text="heading">The Design Language and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles</h2>
1212
</div>
1313
<nve-divider></nve-divider>
@@ -26,7 +26,7 @@
2626
</div>
2727
<div nve-layout="column gap:sm">
2828
<p nve-text="label semibold">Stable API Contracts</p>
29-
<p nve-text="body sm muted"><a href="docs/mcp/#skills" nve-text="link no-visit">Skills</a> and <a href="docs/lint/" nve-text="link no-visit">lint</a> guide authoring best practices, common UI patterns and automated static analysis.</p>
29+
<p nve-text="body sm muted"><a href="docs/mcp/#skills" nve-text="link no-visit">Skills</a> and <a href="docs/lint/" nve-text="link no-visit">lint</a> guide authoring best practices, common Design System UI patterns and automated static analysis.</p>
3030
</div>
3131
</section>
3232
<nve-divider></nve-divider>

‎projects/styles/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# @nvidia-elements/styles
22

3+
NVIDIA Design System and UI Agent Harness for AI/ML Factories, Robotics, and Autonomous Vehicles.
4+
35
Core CSS foundation for the Elements design system, providing layout utilities, typography styles, and view transitions.
46

57
- [Documentation](https://NVIDIA.github.io/elements/)

0 commit comments

Comments
 (0)