Writing Comments
withastro/astro
How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.
Helps update UUI documentation, add doc examples, configure Property Explorer, and manage component API documentation.
$ npx skills add epam/UUI --skill uui-documentation -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install epam/UUI uui-documentation --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ 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-srcUse ~/.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/
Install the "uui-documentation" agent skill from https://github.com/epam/UUI/tree/develop/.cursor/skills/documentation into .claude/skills/uui-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "uui-documentation", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/epam/UUI/tree/develop/.cursor/skills/documentationType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add epam/UUI --skill uui-documentation -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install epam/UUI uui-documentation --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/epam/UUI.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.cursor/skills/documentation .agents/skills/uui-documentation && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "uui-documentation" agent skill from https://github.com/epam/UUI/tree/develop/.cursor/skills/documentation into .agents/skills/uui-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "uui-documentation", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add epam/UUI --skill uui-documentation -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install epam/UUI uui-documentation --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/epam/UUI.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.cursor/skills/documentation .cursor/skills/uui-documentation && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "uui-documentation" agent skill from https://github.com/epam/UUI/tree/develop/.cursor/skills/documentation into .cursor/skills/uui-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "uui-documentation", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/epam/UUI.git --path .cursor/skills/documentation--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add epam/UUI --skill uui-documentation -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install epam/UUI uui-documentation --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/epam/UUI.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.cursor/skills/documentation .gemini/skills/uui-documentation && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "uui-documentation" agent skill from https://github.com/epam/UUI/tree/develop/.cursor/skills/documentation into .gemini/skills/uui-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "uui-documentation", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install epam/UUI uui-documentationInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add epam/UUI --skill uui-documentation -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/epam/UUI.git skills-src && mkdir -p .github/skills && cp -r skills-src/.cursor/skills/documentation .github/skills/uui-documentation && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "uui-documentation" agent skill from https://github.com/epam/UUI/tree/develop/.cursor/skills/documentation into .github/skills/uui-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "uui-documentation", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add epam/UUI --skill uui-documentation -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install epam/UUI uui-documentation --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/epam/UUI.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.cursor/skills/documentation .opencode/skills/uui-documentation && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "uui-documentation" agent skill from https://github.com/epam/UUI/tree/develop/.cursor/skills/documentation into .opencode/skills/uui-documentation/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "uui-documentation", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
uui-documentationHelps 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. 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.
5 steps, taken from the first numbered list in SKILL.md.
Read from SKILL.md and the folder at commit fd11393. It shows what the files ask for, not the result of running them.
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.
Shell commands in SKILL.md call:
yarnFrom the folder's file list and the shell code blocks in SKILL.md.
Links to these hosts (documentation or services it may open):
uui.epam.comFrom URLs in SKILL.md, links to its own repository left out.
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
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.
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.
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.
The full file from epam/UUI at commit fd11393, republished under its MIT licence (© epam). 391 words, ~1,272 tokens.
.claude/skills/uui-documentation/SKILL.md (or your agent's skills folder).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/.
app/src/docs/_examples and open/add folder for your componentexample-name.example.tsxapp/src/docs/pages/components/<component>.json):{
"id": "alert",
"name": "Alert",
"parentId": "components",
"examples": [
{ "descriptionPath": "alert-descriptions" },
{ "name": "Basic", "componentPath": "alert/Basic.example.tsx" }
]
}app/src/documents/structure/components.ts for sidebar menuProperty 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.
app/src/docs/explorerConfigs and find/add config filecontexts: [
TDocContext.Default,
TDocContext.Resizable,
TDocContext.Form,
TDocContext.Table
]bySkin mapping: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 },
}doc: (doc: DocBuilder<uui.TextInputProps>) => {
doc.merge('type', { defaultValue: 'text' });
doc.merge('maxLength', { examples: [10, 20, 30] });
}Component API section is auto-generated from prop interfaces.
Generate locally:
yarn generate-components-apiImportant: 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.
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:
/** 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).
To connect external themes (not in UUI repo):
Add to localStorage:
localStorage.setItem('uui-custom-themes', JSON.stringify({
customThemes: [
"https://cdn.example.com/theme-1",
"https://cdn.example.com/theme-2"
]
}))Theme URL must serve /theme-manifest.json with structure:
interface IThemeManifest {
id: string;
name: string;
css: string[];
settings?: string | null;
propsOverride?: { [typeRef: string]: { [propName: string]: IThemeManifestPropOverride } };
}When adding new functionality:
app/src/docs/_examplesyarn generate-components-api© epam, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Just SKILL.md in .cursor/skills/documentation of epam/UUI.
Open the folder on GitHubat commit fd11393
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.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Uui Documentation this skillepam/UUI | 248 | — | ~1.3k | Automated safety check: Pass | MIT | |
| Writing Commentswithastro/astro | 63k | — | ~2.7k | Automated safety check: Pass | Custom licence | |
| Eisland Dev Update DocsJNTMTMTM/eIsland | 320 | — | ~1.4k | Automated safety check: Pass | GPL-3.0 | |
| Eisland Dev Update DocsJNTMTMTM/eIsland | 320 | — | ~1.8k | Automated safety check: Pass | GPL-3.0 | |
| Docsccusage/ccusage | 19k | — | ~261 | Automated safety check: Pass | Custom licence | |
| Corvus Docs Websitecorvus-dotnet/Corvus.JsonSchema | 199 | — | ~1.3k | Automated safety check: Pass | Apache-2.0 |
withastro/astro
How to write JSDoc (/ /) and inline (//) comments in the Astro codebase, for contributors reading the source — not end users.
JNTMTMTM/eIsland
Update or create documentation in the eIsland VuePress docs site (web/eisland-web-docs).
JNTMTMTM/eIsland
Update or create documentation in the eIsland VuePress docs site (web/eisland-web-docs).
ccusage/ccusage
Routes ccusage documentation impact work. An agent skill from ccusage/ccusage.
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).
NewFuture/DDNS
Maintain DDNS VitePress documentation with bilingual parity, correct navigation and links, safe executable-doc changes, and build verification.
epam/UUI
Helps create and modify UUI (EPAM Unified UI) components following established patterns.
epam/UUI
Helps work with UUI DataSources (ArrayDataSource, LazyDataSource, AsyncDataSource) powering PickerInput, DataTable, FiltersPanel, and other data-driven components.
epam/UUI
Helps create and maintain E2E and screenshot tests for UUI components using Playwright.
epam/UUI
Fetches GitHub issues from URLs and creates implementation plans for UUI.
epam/UUI
Guides the UUI pull request process including branch naming, pre-PR checklist, changelog updates, and quality requirements.
epam/UUI
Helps work with UUI services layer including ContextProvider, ApiContext, ModalContext, NotificationContext, and useUuiContext.
Categories
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.
Uui Documentation fits situations like: adding documentation examples; updating Property Explorer configs; generating API references; working with UUI documentation site.
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.
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.
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.
Going by SKILL.md and its folder, Uui Documentation needs the command-line tools its instructions call (yarn).
SKILL.md names 1 domain. As links in the text: uui.epam.com. This is read from the text; nothing was executed.
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.
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.
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.
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.
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.