SuperAPI AI Directory

seed-component-docs

Writing & research

View repository

Updated 11-05 00:45

About this skill

SEED component documentation

The documentation describing a single component has three layers. The shared guide and the Figma page carry the same content in two media, and the platform documentation translates that content into a code contract. Determine which layer the request changes and read only that reference.

Deliverable Reference to read Input
Shared guide MDX docs/content/components/<id>.mdx guide-doc.md Basis for component role, parts, properties, and usage rules (Figma page, implementation, PRD, user description)
Figma SEED-Docs page figma-doc.md Guide MDX or a draft with the same content, target file and page
Migration from an existing Figma page to guide MDX figma-migration.md + guide-doc.md Figma node URL
React and Lynx documentation docs/content/{react,lynx}/components/<name>.mdx platform-doc.md Implementation source, Registry snippet, example files

When the guide and Figma are requested together, finalize the guide MDX body first and then move that text to Figma. Do not write the sentences for the two media separately.

Boundaries

  • Documentation work does not change component implementation, Recipes, or the Registry. If you discover an API or behavior problem while writing documentation, do not use a documentation workaround; instead, seed-componentseparate it into a change to the existing implementation.
  • Writing and running example files, the Registry deployment path, Lynx compatibility frontmatter, and device verification are handled by seed-component의 lynx-docs.md·lynx-docs-authoring.md·implementation-steps.md. platform-doc.md determines only the sentences and structure.
  • Existing pages in the Figma source file (SEED-Docs) are modified only on the page and branch specified by the user. Before calling use_figma, read the figma-use Skill.
  • Verification of documentation changes is a review of content, links, and format. For the docs/ build check, follow docs/AGENTS.md"Verification".