zoriya/v10
1
0
Fork 0
mirror of https://github.com/zoriya/v10.git synced 2026-08-16 02:45:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore(root): refresh agent skills and docs (#1835)

Browse Source
This commit is contained in:
rahim
2026-07-27 16:21:40 -07:00
committed by GitHub
parent b4b30b0a01
commit fd4d2662ea
206 changed files with 2199 additions and 22577 deletions
Download Patch File Download Diff File Expand all files Collapse all files
site/src/content/docs/how-to/write-guides.mdx
+2 -2
View File
@@ -31,7 +31,7 @@ First, read and understand [Diátaxis](https://diataxis.fr/). We organize docume
1. **Concept pages** (`src/content/docs/concepts/`): Explain how and why things work — design decisions, trade-offs, and context. General understanding, spanning multiple APIs, can be applied to multiple outcomes. As we write guides, what are things we need people to understand in multiple places and don’t want to duplicate the content? Diátaxis calls this mode "explanation."
2. **How-to guides** (`src/content/docs/how-to/`): Spans multiple concepts in order to achieve a specific outcome with step-by-step instructions. Address a real user goal, assume competence, and link to concept pages instead of explaining inline.
3. **Reference pages** (`src/content/docs/reference/`): Component API documentation. These are scaffolded using the `api-reference` skill and the api-docs-builder. Again, see <DocsLink slug="reference/write-references">Write reference pages</DocsLink> for details.
3. **Reference pages** (`src/content/docs/reference/`): Component API documentation. These are scaffolded using `write-api-reference` and the api-docs-builder. Again, see <DocsLink slug="reference/write-references">Write reference pages</DocsLink> for details.
<Aside type="note">
Diátaxis has a fourth mode — learning-oriented **tutorials**. We don't have a tutorials section yet — something we've intentionally chosen to omit, for now. Learning-oriented content lives in the Getting started how-to guides instead.
@@ -577,7 +577,7 @@ Which renders as:
</StyleCase>
</FrameworkCase>
See the "Interactive Demos" section of `site/CLAUDE.md` for how to author the demo files themselves (directory structure, CSS class naming, and the HTML `.astro` wrapper).
Agent-assisted changes should follow the demo rules in `site/AGENTS.md`; all contributors should follow neighboring demos for the current file structure.
## Literally any other component
site/src/content/docs/reference/write-references.mdx
+2 -2
View File
@@ -9,7 +9,7 @@ import DocsLink from '@/components/docs/DocsLink.astro';
This guide covers how to create API reference pages — both component references and util references (hooks, controllers, mixins) under `reference/` in the docs sidebar.
<Aside type="tip">
Reference pages are scaffolded with the `api-reference` Claude skill. Run `/api-reference play-button` to generate a reference page interactively.
Reference pages use the portable `write-api-reference` agent skill. Invoke `/write-api-reference play-button` in clients that expose skills as slash commands.
</Aside>
## Prerequisites
@@ -44,7 +44,7 @@ The builder relies on file naming conventions to discover components:
| React component | `packages/react/src/ui/{name}/` | `packages/react/src/ui/play-button/` |
| Multi-part detection | `index.parts.ts` | `packages/react/src/ui/slider/index.parts.ts` |
If the builder output is missing or incomplete, check that your files match these conventions. See `.claude/skills/api-reference/references/builder-conventions.md` for the full list.
If the builder output is missing or incomplete, check that your files match these conventions. See `.agents/skills/write-api-reference/references/builder-conventions.md` for the full list.
## Create demo files