Create Doc
Developmentcreate-docCreate Doc is an Agent Skill for development published in the skeletonlabs/skeleton repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Scaffold a new documentation page for the Skeleton documentation site (sites/skeleton.dev), including frontmatter, optional boilerplate, examples, and API reference.
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Inspect the Agent Skill at https://github.com/skeletonlabs/skeleton/blob/HEAD/.claude/skills/create-doc/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/create-doc, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Create Doc
Scaffold a new .mdx documentation page for sites/skeleton.dev/ (Astro + MDX).
Where things live
- Pages: sites/skeleton.dev/src/content/docs/
- Examples (mirrors docs structure): sites/skeleton.dev/src/components/examples/
- Frontmatter schema (Zod): sites/skeleton.dev/src/content.config.ts —
docscollection <Preview>,<Framework>,<ApiReference>are globally available in MDX (no import needed)
Categories
| Category | Reference page to model after |
|---|---|
framework-components/ | accordion.mdx — Default + per-feature sections + Anatomy + API Reference |
tailwind-components/ | buttons.mdx — Default .astro + per-feature sections |
tailwind-utilities/ | presets.mdx — utility class doc with <Preview> examples per variant |
design/ | colors.mdx — long-form prose with summary |
get-started/ | introduction.mdx |
guides/ | mode.mdx |
integrations/ | melt-ui.mdx — <Process> + linker CTAs |
resources/ | llms.mdx |
Match the structure of the reference page for the chosen category.
Naming conventions
Filename and title must be derived from the source artifact, never invented. Recommend the derived name, explain the source, accept overrides.
- Framework Components — derived from
packages/skeleton-{framework}/src/components/{ComponentName}.Accordion→accordion.mdx, titleAccordion. If the component doesn't exist yet, flag this — user may need/create-componentfirst. - Tailwind Components — derived from the CSS filename.
@btnlives inbuttons.css→buttons.mdx, titleButtons. Plural CSS filename verbatim. - Tailwind Utilities — derived from the CSS filename of the utility set.
presets.css→presets.mdx, titlePresets. Use this category for cross-cutting utility classes (Presets, etc.) rather than discrete component blocks. - Tailwind exceptions (no new page) — typography utilities go into design/typography.mdx; form/input fields go into tailwind-components/forms.mdx. Recommend extending those instead of creating a new page.
- All other categories — kebab-case slug from the topic, Title Case title.
Prompt flow
Ask one at a time, confirm each answer, write nothing until all are answered and the user confirms.
- Topic — title and one-line description.
- Destination — recommend
<category>/<slug>.mdxper naming conventions, explain the derivation, surface the typography/forms exception when relevant. Allow override. - Boilerplate vs blank — blank = frontmatter only; boilerplate = match the category reference page.
- Examples — collect a list of example names (always include
Defaultas the first). Per example, infer the type from the parent category — don't re-prompt: tailwind pages →.astro; framework pages → react + svelte pair. Note any exceptions the user mentions (e.g. "makegroupframework-specific on a tailwind page"). - API Reference — append
<ApiReference id="<framework>/<slug>" />blocks (see accordion.mdx). The id must match an entry in the components collection loader; warn if the component isn't registered yet. - Other notes —
linkerCTA,summary/order/stabilityoverrides,referencesURLs, cross-links.
Frontmatter
See content.config.ts for the full schema. Required: title, description. Useful optionals: summary, order, stability, references.{source,styles,a11y,zag}.
Examples
Refer to the /create-example skill for general best practices. Avoid the prompt-flow for each example as this could be tedious. Just use your best judgement from the information received and the skill spec.
Final summary
After writing files, list: page path, examples handed to /create-example, anything needing manual follow-up (e.g. component registration for <ApiReference>, asset imports, populating example bodies).