Agent skill

Uui Documentation

by epam in epam/UUI

Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation.

MITAuto-check passedDevelopment

Install Uui Documentation

skills CLI
$ npx skills add epam/UUI --skill uui-documentation -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install epam/UUI uui-documentation --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/epam/UUI.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.cursor/skills/documentation .claude/skills/uui-documentation && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
uui-documentation
GitHub stars
248
Token cost
~1.3k tokens
SKILL.md length
391 words
Files
1
Skills in repo
10
Repo updated
First seen
Licence
MIT

At a glance

Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation.

  • Works in 5 steps: Go to app/src/docs/_examples and… → Add example file: example-name.example.tsx → Add link in page config… → …
  • Adding documentation examples
  • SKILL.md covers Add Doc Example, Property Explorer, API Block and External Themes, plus 1 more section
  • Calls yarn

What it does

Uui Documentation is an agent skill from epam/UUI. Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation. Use when adding documentation examples, updating Property Explorer configs, generating API references, working with UUI documentation site, or when adding/removing/modifying public props on component interfaces.

Its SKILL.md is about 1.3k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation and Static sites and blogs. The repository describes itself as: React-based components and accelerators library built by EPAM Systems. The licence is MIT.

When your agent uses it

  • Adding documentation examples
  • Updating Property Explorer configs
  • Generating API references
  • Working with UUI documentation site

Example prompts

  • “Use the uui-documentation skill to help update UUI documentation, add doc examples, configure Property Explorer, and manage component API…”
  • “/uui-documentation”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

  1. Go to app/src/docs/_examples and open/add folder for your component
  2. Add example file: example-name.example.tsx
  3. Add link in page config (app/src/docs/pages/components/.json)
  4. If adding new page, register it in app/src/documents/structure/components.ts for sidebar menu
  5. Open local environment (http://localhost:9009/), navigate to page, add description via RTE field

What it can do on your machine

Read from SKILL.md and the folder at commit fd11393. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • yarn

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    Links to these hosts (documentation or services it may open):

    • uui.epam.com

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Uui Documentation loads about 1.3k tokens when it runs. Until then it costs about 87 tokens; SKILL.md has 391 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~87
When it runs · the whole SKILL.md, loaded when a task matches
~1.3k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from epam/UUI at commit fd11393, republished under its MIT licence (© epam). 391 words, ~1,272 tokens.

Download SKILL.mdSave it as .claude/skills/uui-documentation/SKILL.md (or your agent's skills folder).
name
uui-documentation
description
Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation. Use when adding documentation examples, updating Property Explorer configs, generating API references, working with UUI documentation site, or when adding/removing/modifying public props on component interfaces.

UUI Documentation

UUI documentation is published on uui.epam.com. Sources are in ./app folder.

Dependency: Property Explorer configs and doc examples use @epam/uui-docs, which provides DocBuilder, TDocContext, TSkin, DocPreviewBuilder, demo API, and PE editors. The package lives in uui-docs/.

Add Doc Example

  1. Go to app/src/docs/_examples and open/add folder for your component
  2. Add example file: example-name.example.tsx
  3. Add link in page config (app/src/docs/pages/components/<component>.json):
    json
    {
        "id": "alert",
        "name": "Alert",
        "parentId": "components",
        "examples": [
            { "descriptionPath": "alert-descriptions" },
            { "name": "Basic", "componentPath": "alert/Basic.example.tsx" }
        ]
    }
  4. If adding new page, register it in app/src/documents/structure/components.ts for sidebar menu
  5. Open local environment (http://localhost:9009/), navigate to page, add description via RTE field

Property Explorer

Property Explorer lets users interactively test components in different prop variations. Most content is auto-generated from component prop types.

Preview vs screenshot tests: The preview function in explorerConfigs defines Preview pages for documentation — users can switch props and see changes. Screenshot tests (in e2e-testing) use these same previews to capture baseline images. Create previews here for docs; add screenshot test entries in preview.e2e.ts to include them in E2E.

Add/Update ExplorerConfig
  1. Go to app/src/docs/explorerConfigs and find/add config file
  2. Use same id as page config where PE should be connected
  3. Add contexts:
    typescript
    contexts: [
        TDocContext.Default,
        TDocContext.Resizable,
        TDocContext.Form,
        TDocContext.Table
    ]
  4. Define bySkin mapping:
    typescript
    bySkin: {
        [TSkin.UUI]: { type: '@epam/uui:TextInputProps', component: uui.TextInput },
        [TSkin.Loveship]: { type: '@epam/uui:TextInputProps', component: loveship.TextInput },
        [TSkin.Promo]: { type: '@epam/uui:TextInputProps', component: promo.TextInput },
        [TSkin.Electric]: { type: '@epam/uui:TextInputProps', component: electric.TextInput },
    }
  5. (Optional) Override prop editor defaults:
    typescript
    doc: (doc: DocBuilder<uui.TextInputProps>) => {
        doc.merge('type', { defaultValue: 'text' });
        doc.merge('maxLength', { examples: [10, 20, 30] });
    }

API Block

Component API section is auto-generated from prop interfaces.

Generate locally:

bash
yarn generate-components-api

Important: You must run this command locally whenever public props/types are added, removed, or modified (in uui-core, uui-components, uui, etc.), and commit the updated files under public/docs/docsGenOutput/. Without this step, new or changed props will not appear in the Property Explorer or API docs, and the PR quality gate may fail.

Show full SKILL.md (159 more words)Show less
JSDoc comments (required)

Exported types and their own (non-inherited) props must have JSDoc comments — API docs and Property Explorer use them for descriptions.

The PR quality gate fails if the number of exported props without JSDoc increases vs the target branch (The amount of props/type without comments is increased). Always add JSDoc when introducing or changing public types/props:

ts
/** Props for the authentication recovery service. */
export type AuthRecoveryContextProps = {
    /** Url to the relogin page opened when auth is lost. */
    apiReloginPath: string;
};

CI report details list new gaps under New missing comments (TypeRef / TypeRef/propName).

External Themes

To connect external themes (not in UUI repo):

  1. Add to localStorage:

    javascript
    localStorage.setItem('uui-custom-themes', JSON.stringify({
        customThemes: [
            "https://cdn.example.com/theme-1",
            "https://cdn.example.com/theme-2"
        ]
    }))
  2. Theme URL must serve /theme-manifest.json with structure:

    typescript
    interface IThemeManifest {
        id: string;
        name: string;
        css: string[];
        settings?: string | null;
        propsOverride?: { [typeRef: string]: { [propName: string]: IThemeManifestPropOverride } };
    }

Workflow

When adding new functionality:

  1. Add doc example in app/src/docs/_examples
  2. Update page config to link example
  3. Create/update explorerConfig for Property Explorer
  4. Add JSDoc on new/changed public types and props
  5. Generate API: yarn generate-components-api
  6. Test locally at http://localhost:9009/

© epam, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .cursor/skills/documentation of epam/UUI.

Open the folder on GitHubat commit fd11393

Compare with similar skills

Uui Documentation next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Uui Documentation compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Uui Documentation this skillepam/UUI248—~1.3kAutomated safety check: PassMIT
Writing Commentswithastro/astro63k—~2.7kAutomated safety check: PassCustom licence
Eisland Dev Update DocsJNTMTMTM/eIsland320—~1.4kAutomated safety check: PassGPL-3.0
Eisland Dev Update DocsJNTMTMTM/eIsland320—~1.8kAutomated safety check: PassGPL-3.0
Docsccusage/ccusage19k—~261Automated safety check: PassCustom licence
Corvus Docs Websitecorvus-dotnet/Corvus.JsonSchema199—~1.3kAutomated safety check: PassApache-2.0

Similar skills

  • Writing Comments

    withastro/astro

    Official

    How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.

    63k GitHub stars~2.7k tokensUpdated today
    DevelopmentAuto-check passed
  • Eisland Dev Update Docs

    JNTMTMTM/eIsland

    Update or create documentation in the eIsland VuePress docs site (web/eisland-web-docs).

    320 GitHub stars~1.4k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Eisland Dev Update Docs

    JNTMTMTM/eIsland

    Update or create documentation in the eIsland VuePress docs site (web/eisland-web-docs).

    320 GitHub stars~1.8k tokensUpdated today
    Agent WorkflowsAuto-check passed
  • Docs

    ccusage/ccusage

    Routes ccusage documentation impact work. An agent skill from ccusage/ccusage.

    19k GitHub stars~261 tokensUpdated today
    DevelopmentAuto-check passed
  • Corvus Docs Website

    corvus-dotnet/Corvus.JsonSchema

    Build, serve, and maintain the Corvus.Text.Json documentation website and the six Blazor WASM playgrounds (JSON Schema, JSONata, JMESPath, JsonLogic, JSONPath, YAML).

    199 GitHub stars~1.3k tokensUpdated today
    DevelopmentAuto-check passed
  • Maintain DDNS VitePress documentation with bilingual parity, correct navigation and links, safe executable-doc changes, and build verification.

    4.7k GitHub stars~324 tokensUpdated yesterday
    DevelopmentAuto-check passed

More from epam/UUI

All 10 skills in this repo
  • Helps create and modify UUI (EPAM Unified UI) components following established patterns.

    248 GitHub stars~2.8k tokensUpdated 8 days ago
    Auto-check passed
  • Helps work with UUI DataSources (ArrayDataSource, LazyDataSource, AsyncDataSource) powering PickerInput, DataTable, FiltersPanel, and other data-driven components.

    248 GitHub stars~1.5k tokensUpdated 8 days ago
    Auto-check passed
  • Helps create and maintain E2E and screenshot tests for UUI components using Playwright.

    248 GitHub stars~1.3k tokensUpdated 8 days ago
    Auto-check passed
  • Fetches GitHub issues from URLs and creates implementation plans for UUI.

    248 GitHub stars~1.5k tokensUpdated 8 days ago
    Auto-check passed
  • Guides the UUI pull request process including branch naming, pre-PR checklist, changelog updates, and quality requirements.

    248 GitHub stars~1.7k tokensUpdated 8 days ago
    Auto-check: notes
  • Helps work with UUI services layer including ContextProvider, ApiContext, ModalContext, NotificationContext, and useUuiContext.

    248 GitHub stars~1.2k tokensUpdated 8 days ago
    Auto-check passed

Questions about Uui Documentation

What does Uui Documentation do?

Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation. Uui Documentation is an agent skill from epam/UUI. Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation.

When should I use Uui Documentation?

Uui Documentation fits situations like: adding documentation examples; updating Property Explorer configs; generating API references; working with UUI documentation site.

How do I install Uui Documentation in Claude Code?

Run `npx skills add epam/UUI --skill uui-documentation -a claude-code`. Or copy the skill folder (.cursor/skills/documentation in epam/UUI) into .claude/skills/uui-documentation in your project. Claude Code loads it when a task matches its description.

How do I install Uui Documentation in Codex?

Run `npx skills add epam/UUI --skill uui-documentation -a codex`. Or copy the skill folder (.cursor/skills/documentation in epam/UUI) into .agents/skills/uui-documentation in your project. Codex loads it when a task matches its description.

Can I use Uui Documentation in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add epam/UUI --skill uui-documentation -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/uui-documentation, .gemini/skills/uui-documentation, .github/skills/uui-documentation and .opencode/skills/uui-documentation in your project.

What does Uui Documentation need to run?

Going by SKILL.md and its folder, Uui Documentation needs the command-line tools its instructions call (yarn).

Does Uui Documentation access the network?

SKILL.md names 1 domain. As links in the text: uui.epam.com. This is read from the text; nothing was executed.

Is Uui Documentation safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Uui Documentation use?

Uui Documentation is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Uui Documentation use?

About 1.3k tokens (SKILL.md is roughly 5.1k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Uui Documentation?

Skills that share tags, products or a category with Uui Documentation: Writing Comments (withastro/astro, 63k stars), Eisland Dev Update Docs (JNTMTMTM/eIsland, 320 stars), Eisland Dev Update Docs (JNTMTMTM/eIsland, 320 stars) and Docs (ccusage/ccusage, 19k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Uui Documentation?

epam (a GitHub organization) maintains it in epam/UUI, which has 248 GitHub stars. The repository holds 10 skills in this directory. The repository was last updated on September 29, 2026.

Source: epam/UUI on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.