Generate HTML API documentation for Squint endpoints from extracted codebase types.
npx skills add https://github.com/kvnxiao/.dotfiles --skill api-docs-kvnxiao
Please help me install this Agent Skill. Skill: api-docs Source: https://github.com/kvnxiao/.dotfiles/tree/main/claude/skills/api-docs Command: npx skills add https://github.com/kvnxiao/.dotfiles --skill api-docs-kvnxiao
This Skill automates the creation of HTML API documentation for Squint endpoints, converting codebase metadata into structured, navigable docs that can be consumed by external developers.
Run the documentation generator on a target API module or let it scan the repository to discover endpoints.
High-intent search queries and answers about installing and using this skill.
To generate HTML API documentation for Squint endpoints, run the documentation generator on a target API module or let it scan the repository to discover endpoints. It extracts router, handler, and service metadata to produce structured HTML docs.
Generated API documentation is compatible with Google Docs, producing structured HTML output that details request and response structures. You can share these HTML docs directly into documents or onboarding portals for external developers.
API documentation for external-facing endpoints should detail request and response structures, authentication methods, and error mappings. This ensures external developers and partners understand integration requirements by extracting metadata from the codebase.
Automated endpoint documentation handles internal integrations by extracting router, handler, service, and response types from the codebase. It applies the same structured HTML formatting to both external-facing endpoints and internal integrations.
You do not need to manually format the output of generated developer docs. The output adheres to predefined HTML templates to ensure consistent formatting and standardized structure across all generated API documentation files.
The generated HTML API documentation gets saved to the docs/api-docs/api/v1 directory. This standardized output location ensures developers can consistently find and access the endpoint documentation within the repository.
Snowflake-LabsA concise summary of your roleplay character: name,</name> personality, and/or behavior, formatted as a single string sentence. Typically不超过50字，此处省略
wuyyyyyouGrant edit access to a Google Docs document and email the share link to collaborators.
mislam-devGenerates OpenAPI 3.0 spec and HTML docs from codebases.
bayzhenGenerate HTML articles with inline CSS, responsive design, and navigation links.
