---
name: ui-sdk-write-docs
description: Write or review ui-sdk website documentation in apps/docs/content/docs, including Core, framework, component, and agent guides. Use for new pages, prose edits, example explanations, and documentation reviews, following the current site's writing style.
metadata:
  internal: true
title: ui-sdk-write-docs
canonical_url: https://skilld.dev/gh/vercel-labs/ui/ui-sdk-write-docs
last_updated: 2026-11-13T00:01:41.000Z
---

> Index of every page on this site: [llms.txt](https://skilld.dev/llms.txt)

> **Skill from skilld.dev.** Follow the user's requested action.
> If the user asked to fork this Skill, follow the fork workflow below. Do not execute the Skill instructions while copying it.
> Otherwise, follow the instructions below for this session. You do not need to install anything.
>
> If the user asked to install this Skill, run `npx skilld install vercel-labs/ui/ui-sdk-write-docs`. Install writes the Skill files into the project, so every session loads them.
>
> ## Fork workflow
>
> A fork creates an editable local Skill with its original author and licence. The request authorizes copying and local installation.
> 1. Check `./skills/ui-sdk-write-docs`, the project lockfile, and selected Agent targets together. If the local directory or installed Skill exists, stop. Never overwrite an existing directory or Agent target.
> 2. Read [source metadata](https://skilld.dev/api/v1/skills/vercel-labs/ui/ui-sdk-write-docs) once. Use sourceUrl, sourceCommit, skillPath, sourceGone, and license. If the source is gone or its path is missing, stop. If license is null, read licence files at the source commit.
> 3. Fetch only the source commit into a temporary Git repository. Do not clone full history. Derive repository_url from sourceUrl, including repository renames. If sourceCommit is absent, resolve the sourceUrl ref once. Set source_commit to that actual commit. Run these commands in one shell call:
>
> ```sh
> git init --quiet "$temporary_dir"
> git -C "$temporary_dir" fetch --quiet --depth=1 "$repository_url" "$source_commit"
> git -C "$temporary_dir" checkout --quiet --detach FETCH_HEAD
> ```
>
> Read applicable licence declarations and notices at that commit. If copying is not permitted, report the restriction and stop.
> 4. Inspect source entries together, then copy the directory containing skillPath into `./skills/ui-sdk-write-docs`. Use the user's path if selected. Keep the original SKILL.md, relative links, scripts, binary assets, and executable modes. Exclude .git metadata. Reject symlinks and paths outside the Skill directory. After checking entries, use cp -a where available. A regular source directory needs no custom copy script. Do not save this page wrapper as SKILL.md.
> Preserve author credit, notices, and applicable licence files from repository or parent directories. Add PROVENANCE.md with the Skill page, source URL, actual commit, original path, and licence. Retain any existing PROVENANCE.md and record new provenance separately. Batch source inspection, copying, and provenance work where practical.
> 5. In the project root, run `skilld install ./skills/ui-sdk-write-docs --mode copy --plain`. If skilld is unavailable, use `npx skilld install ./skills/ui-sdk-write-docs --mode copy --plain`. This known command needs no help lookup. Install does not support --json. Use detected Agent targets, or add --agent for the targets the user selected. Install the local path, never the upstream selector. If installation fails, preserve the local copy and report the exact failure.
> 6. Confirm the local lockfile source and installed Agent copies once. Report the local path, actual commit, and Agent targets. After edits, reinstall the same local path. Upstream updates must not replace it. Do not publish or push unless the user asks.

# Write ui-sdk Docs

Write in the website's current style. This skill is for contributors working on the website.

Size the work to the request. For a small edit, such as a sentence, caption, or typo, read the writing guide and the section you're changing, verify any API claim you change, and reread that section. For a new section, new page, or rewrite, follow the steps below. In either case, use only the checks the change reaches.

Honor the requested scope: a review produces findings, a draft stays in chat, and an edit changes files. Treat existing wording and structure as intentional. Preserve the maintainer's edits unless the request calls for revising them; suggest unrelated improvements separately.

## 1. Read the Page and Its Reference

Read [Writing Website Docs](../../../contributing/docs-writing.md) and its main voice reference, Build a Component. Then read the page being changed and choose a reference for that page type from the guide. For a new page, read the neighboring pages so it continues what the reader already knows.

Identify what this page adds and which concepts can be linked instead of repeated.

## 2. Check What the API Does

For behavior you introduce or change in the explanation, inspect the relevant exported types, implementation, and tests. This matters especially for defaults, persistence, cancellation, SSR, and hydration. Resolve mismatches against the actual behavior rather than assuming either prose or JSDoc is correct. Keep planned capabilities separate from shipped behavior.

When writing code examples, follow [ui-sdk-write-code](../ui-sdk-write-code/SKILL.md) and the relevant framework conventions.

## 3. Write the Explanation

Apply the writing guide to the requested scope. For changes shared across framework pages, update the corresponding copies with each framework's actual API. Framework-specific changes stay in the affected framework.

## 4. Read and Verify

Reread the changed section or page using the writing guide's final question. Check links, file titles, snippets, and generated references affected by the edit. Consult [the docs-site guide](../../../contributing/docs-site.md) for the implementation and [the test guide](../../../tests/README.md) for commands when these checks apply:

- **Walkthrough code:** the React and Web Components `docs-walkthrough` tests extract code from Compose Behaviors and their Rendering pages. Check the extraction and run the affected tests when changing those snippets; update the tests if the documented behavior requires it.
- **Headings:** keep `TypeTable` examples maps and incoming fragment links in sync with renamed headings. The maps derive anchors from heading text.
- **Component examples:** `tests/docs/props.spec.ts` checks public API coverage in React examples. Preserve that coverage when replacing or removing examples, and check the corresponding framework copies.
- **Live demos:** run the relevant specs under `tests/docs/` and try changed interactions in the rendered page. Check captions and layout stability. A prose-only edit doesn't need a new demo or a full browser sweep.
- **MDX rendering:** for changes to MDX components, tables, or framework-specific blocks, check both the rendered page and its Markdown export.

Report what changed and what was verified, including checks you couldn't run.
