repo-website-api-create

To generate API documentation routes, the skill reads your source code to extract interfaces, types, and function signatures, then organizes them into an index.mdx file with frontmatter and a properties.ts file. This ensures every exported function, type, or component has dedicated docs derived directly from the source of truth.

The standard MDX structure for API reference pages requires creating a dedicated folder for each API item containing an index.mdx file with frontmatter and a properties.ts file to map props. You then update the site menu to include the new route following the repository's documentation pattern.

You document newly exported functions and types by applying a template-driven approach that creates a new folder with index.mdx and properties.ts for each item. The skill automates extracting signatures and interfaces from source code to enforce a consistent documentation structure.

You do not need to manually write frontmatter and properties files from scratch. The skill automates the creation of these files by extracting interfaces, types, and function signatures from source code, mapping props into properties.ts, and organizing content into index.mdx.

Yes, the generated API docs support cross-package linking and component references by following the repository's standard documentation pattern. The skill organizes items into index.mdx and properties.ts files, ensuring consistent structure across all new API reference routes.

You should avoid auto-generating API documentation routes when adding documentation for exports that already have existing website entries. The skill specifically applies only to newly exported functions, types, components, or methods that do not yet have dedicated documentation folders.