菜单
Review and verify API documentation routes on the Formisch website. Use when checking documentation accuracy, completeness, and consistency with source code.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/open-circle/formisch --skill repo-website-api-review命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
Add integration guides for using Formisch with UI component libraries (e.g. shadcn/ui, Mantine, Chakra UI) to the Formisch website. Use when documenting how to wire Formisch fields to a component library's inputs.
Add new documentation guides and tutorials to the Formisch website. Use when creating guides about form concepts, features, or techniques that aren't covered by existing documentation.
Create new API documentation routes for the Formisch website. Use when adding documentation for new exported functions, types, components, or methods that don't yet have website documentation.
基于 SOC 职业分类
正在显示 SKILL.md
| name | repo-website-api-review |
| description | Review and verify API documentation routes on the Formisch website. Use when checking documentation accuracy, completeness, and consistency with source code. |
| metadata | {"author":"formisch","version":"1.0"} |
This skill provides a systematic approach to reviewing API documentation routes for accuracy and consistency.
For each documented API:
Verify each property:
href links are validVerify content:
// Source code
export function validate(form: FormStore, config?: Config): void;
// ❌ Documentation shows different signature
const result = validate(form); // Missing config, wrong return
Documentation should include ALL parameters from source:
## Parameters
- `form` <Property {...properties.form} />
- `config` <Property {...properties.config} /> <!-- Don't forget optional params -->
| API Type | Heading |
|---|---|
| Functions | ## Parameters |
| Components | ## Properties |
Examples must work with current API:
// ❌ Old API usage
const form = createForm(schema);
// ✅ Current API
const form = createForm({ schema });
| Framework | Related Section Heading |
|---|---|
| Solid | ### Primitives |
| Qwik | ### Hooks |
| Preact | ### Hooks |
| React Native | ### Hooks |
| Angular | ### Functions / ### Directives |
| Vue | ### Composables |
| Svelte | ### Runes |
// ❌ Wrong - using constraint type name
generics: [{ type: 'custom', name: 'RequiredPath' }];
// ✅ Correct - using parameter name
generics: [{ type: 'custom', name: 'TFieldPath' }];
// ❌ Wrong - relative across packages
href: '../../../core/api/FormSchema/';
// ✅ Correct - absolute path
href: '/core/api/FormSchema/';
modifier: 'extends' (extends unknown when the source has no constraint)href linksname, href, genericshref in properties.ts resolveDocument issues found:
## Review: createForm
### Issues Found
1. **Signature mismatch** (L15)
- Source shows `config: FormConfig<TSchema>`
- Docs show `config: Config`
2. **Missing parameter** (Parameters section)
- `initialInput` not documented
3. **Broken link** (properties.ts L23)
- `href: '../FormConfig/'` - FormConfig not documented
### Recommendations
- Update properties.ts with correct FormConfig type
- Add initialInput to Parameters section
- Create FormConfig type documentation