SkillsAdd

nvidia/elements · Archived

authoring-examples

Guidelines for writing example template files (*.examples.ts) including naming conventions, @summary JSDoc comments, and stateless HTML patterns.

First seen Aug 17, 2026

Installation

$ npx skills add nvidia/elements --skill authoring-examples
View on skills.sh ↗ GitHub repository ↗

Summary

  • Guidelines for writing example template files (*.examples.ts) including naming conventions, @summary JSDoc comments, and stateless HTML patterns.
  • Use this skill whenever the user creates, modifies, or reviews *.examples.ts files, asks about example naming rules (PascalCase, 3-word max, no component prefix), needs to write or improve @summary JSDoc comments, encounters example-naming ESLint errors, or wants to add stateless or interactive examples to a component's example file.

Stronger alternatives

This repository is archived — consider an actively maintained alternative.

api-design Same source · more installs
nvidia/elements

Component API design patterns following Elements conventions for properties, attributes, CSS cu…

2 installs
troubleshooting Same source · more installs
nvidia/elements

Diagnose and resolve common issues including test failures, build errors, performance regressio…

2 installs
authoring-typescript Same source · more installs
nvidia/elements

Best practices for TypeScript code including type safety, discriminated unions, type guards, an…

2 installs
audit-code Same source · more installs
nvidia/elements

Comprehensive code review process for Elements monorepo changes. Provides structured feedback o…

2 installs

Similar popular skills

Related neighbors and high-traction skills in the same topics — useful to compare before installing.

frontend-design Same topic
anthropics/skills

Guidance for distinctive, intentional visual design when building new UI or reshaping an existi…

866.4K installs
agent-browser Same topic
vercel-labs/agent-browser

Browser automation CLI for AI agents. Use when the user needs to interact with websites, includ…

810.4K installs
vercel-react-best-practices Same topic
vercel-labs/agent-skills 697.8K installs
web-design-guidelines Same topic
vercel-labs/agent-skills

Review UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "chec…

617.3K installs
microsoft-foundry Same topic
microsoft/azure-skills

Build, deploy, evaluate, optimize, fine-tune, and manage Microsoft Foundry agents, models, and …

576.5K installs
azure-diagnostics Same topic
microsoft/azure-skills

Debug Azure production issues on Azure using AppLens, Azure Monitor, resource health, and safe …

568.9K installs

Also in this package

Other skills from nvidia/elements · top by installs.

npx skills add nvidia/elements
api-design 2 troubleshooting 2 authoring-typescript 2 audit-code 2 guidance-build 1 audit-accessibility 1 availability-report 1 github-dependabot 1 component-creation 1 testing 1

Browse all from nvidia/elements

More details

Agent compatibility

Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.

Claude Code Not declared
Cursor Not declared
Codex Not declared
GitHub Copilot Not declared
Windsurf Not declared
Gemini CLI Not declared
Cline Not declared
OpenCode Not declared

Repository health

Stars 85
License LICENSE
Default branch main
Status Archived

Package contents

Files included with this skill beyond the listing page.

  • skill md SKILL.md 1,796 B
  • docs SUMMARY.md 507 B

History

  1. First seen on skills.sh
  2. First recorded snapshot · 1 installs

SKILL.md

Authoring Examples (*.examples.ts)

You MUST review @projects/site/src/docs/internal/guidelines/examples.md before making any changes to example files.

When to Use This Skill

  • Creating new *.examples.ts files for components
  • Adding or updating example templates within existing example files
  • Reviewing example naming conventions and structure
  • Writing or updating @summary JSDoc comments for examples

Key Principles

  1. PascalCase Naming: Use PascalCase for example names (for example, Default, StatusFlat, FormSubmit)
  2. Concise Names: Keep example names to 1-3 words maximum, describing what the example shows
  3. Required @summary: Every example must include a @summary JSDoc comment explaining what, why, when, and how
  4. Stateless Templates: Examples should be stateless HTML templates demonstrating UI patterns

Naming Patterns

  • Single words: Default, Status, Size, Color, Disabled
  • Compound names: StatusFlat, StatusIcon, FormSubmit, VerticalTabs
  • Special prefixes: Legacy, Invalid, Valid*

References

  • [Examples Guidelines](/projects/site/src/docs/internal/guidelines/examples.md)
  • [Documentation Guidelines](/projects/site/src/docs/internal/guidelines/documentation.md)