Skip to main content
skillsmp

Menú

authoring-examples

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.

Ir a la instalaciónRevisar archivos

Datos de origen

Repositorio
NVIDIA/elements
Última actividad en el origen
12 de agosto de 2026 a las 00:30
Idioma detectado de SKILL.md
inglés
Estrellas
102
Forks
19

Opciones de instalación

De forma predeterminada está seleccionado el prompt que primero revisa el origen. Puedes cambiar a un comando directo o descargar una copia local.

Revisa los archivos de origen

Lee SKILL.md y los archivos complementarios que muestra SkillsMP antes de decidir si quieres instalarlo.

Mostrando SKILL.md

SKILL.md
Instrucciones de origen · Vista previa de solo lectura
name
authoring-examples
description
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.
# 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)
Ver en GitHub
Volver a la búsquedaVolver a la instalación