repo-website-api-create
Adding API Documentation to Website
Guide for creating new API reference pages at website/src/routes/api/.
Process Overview
- Read source code in
/library/src/ - Create folder in
/website/src/routes/api/(category)/[name]/ - Create
properties.tswith type definitions - Create
index.mdxwith documentation - Update
menu.md - Create type documentation if needed (Issue, Schema/Action interfaces)
File Structure
More from open-circle/valibot
repo-source-code-review
Review pull requests and source code changes in /library/src/. Use when reviewing PRs, validating implementation patterns, or checking code quality before merging. Covers code quality checks, type safety, documentation review, test coverage, and common issues to watch for.
23repo-website-api-update
Update existing API documentation pages after source code changes. Use when syncing docs with library changes like new parameters, type constraint changes, interface updates, or function renames. Covers common change patterns and verification steps.
21repo-website-guide-create
Create conceptual documentation and tutorial pages for the Valibot website at website/src/routes/guides/. Use when adding guides about schemas, pipelines, async validation, migration, or other topics. Covers directory structure, MDX templates, frontmatter, and content guidelines.
21repo-structure-navigate
Navigate the Valibot repository structure. Use when looking for files, understanding the codebase layout, finding schema/action/method implementations, locating tests, API docs, or guide pages. Covers monorepo layout, library architecture, file naming conventions, and quick lookups.
19repo-source-code-document
Write JSDoc comments and inline documentation for Valibot library source code in /library/src/. Use when documenting schemas, actions, methods, or utilities. Covers interface documentation, function overloads, purity annotations, inline comment patterns, and terminology consistency.
19