Pages: API Introduction
Guides the API introduction page →typically at /api →that overviews the API, use cases, and links to documentation. API documentation (endpoint reference, code examples) lives on separate pages.
When invoking: On first use, if helpful, open with 1–2 sentences on what this skill covers and why it matters, then provide the main output. On subsequent use or when the user asks to skip, go directly to the main output.
Initial Assessment
Check for project context first: If .claude/project-context.md or .cursor/project-context.md exists, read it for product and developer use cases.
Identify:
- API type: REST, GraphQL, etc.
- Audience: Developers (integration) vs. decision makers (evaluation)
- Docs location: Where API documentation lives (e.g.
/docs, /api/reference, external)
Page Role
- API page (
/api): Introduction, overview, value prop, CTA to docs or signup
- API documentation: Lives in docs (docs.*) → API Reference section with endpoint reference, auth, examples
Best Practices
Overview and Structure
- What the API does: Clear value proposition, key capabilities
- Use cases: Who uses it, common scenarios
- Getting started: Quick path to first call or docs
- Link to docs: Prominent CTA to API documentation
Content
- Key concepts: High-level, not endpoint-level detail
- Auth overview: How auth works; link to docs for details
- Pricing/limits: If relevant for evaluation
- SDKs and tools: If available; link to docs
SEO and Discovery
- Developer search: Target "API" + product/category terms
- Metadata: Title, description for developer intent
- Internal links: From homepage, features, resources
Output Format
- Structure outline (sections)
- Value proposition and key messages
- CTA to documentation or signup
- SEO metadata for developer search
Related Skills
- homepage-generator: Link to API page for developers
- schema-markup: WebPage or SoftwareApplication schema
- title-tag, meta-description, page-metadata: API page metadata
1---2name: api-page-generator3description: 'When the user wants to create, optimize, or audit the API introduction/overview page. Also use when the user mentions "API page", "API landing page", "/api page" or "API overview". Note: API documentation (endpoint reference) lives in docs; use docs-page-generator.'4metadata:5 source: https://skillmd.com/skills/ariadoss/api-page-generator6 version: 1.0.17---89# Pages: API Introduction1011Guides the API introduction page →typically at `/api` →that overviews the API, use cases, and links to documentation. API documentation (endpoint reference, code examples) lives on separate pages.1213**When invoking**: On **first use**, if helpful, open with 1–2 sentences on what this skill covers and why it matters, then provide the main output. On **subsequent use** or when the user asks to skip, go directly to the main output.1415## Initial Assessment1617**Check for project context first:** If `.claude/project-context.md` or `.cursor/project-context.md` exists, read it for product and developer use cases.1819Identify:201. **API type**: REST, GraphQL, etc.212. **Audience**: Developers (integration) vs. decision makers (evaluation)223. **Docs location**: Where API documentation lives (e.g. `/docs`, `/api/reference`, external)2324## Page Role2526- **API page** (`/api`): Introduction, overview, value prop, CTA to docs or signup27- **API documentation**: Lives in docs (docs.*) → API Reference section with endpoint reference, auth, examples2829## Best Practices3031### Overview and Structure3233- **What the API does**: Clear value proposition, key capabilities34- **Use cases**: Who uses it, common scenarios35- **Getting started**: Quick path to first call or docs36- **Link to docs**: Prominent CTA to API documentation3738### Content3940- **Key concepts**: High-level, not endpoint-level detail41- **Auth overview**: How auth works; link to docs for details42- **Pricing/limits**: If relevant for evaluation43- **SDKs and tools**: If available; link to docs4445### SEO and Discovery4647- **Developer search**: Target "API" + product/category terms48- **Metadata**: Title, description for developer intent49- **Internal links**: From homepage, features, resources5051## Output Format5253- **Structure** outline (sections)54- **Value proposition** and key messages55- **CTA** to documentation or signup56- **SEO** metadata for developer search5758## Related Skills5960- **homepage-generator**: Link to API page for developers61- **schema-markup**: WebPage or SoftwareApplication schema62- **title-tag, meta-description, page-metadata**: API page metadata