agentleFS
Sign inStart free
NVIDIAKnown publisherNVIDIA/elements/.agents/skills/authoring-examples/SKILL.md

authoring-examples

Skill115 starsChanged 55 days agoApache-2.0View on GitHub

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.

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    PascalCase Naming: Use PascalCase for example names (for example, Default, StatusFlat, FormSubmit)

    line 19
  2. Distinctive:

    Concise Names: Keep example names to 1-3 words maximum, describing what the example shows

    line 20
  3. Very specific:

    Required @summary: Every example must include a @summary JSDoc comment explaining what, why, when, and how

    line 21

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
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
  • Documentation Guidelines

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free