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-generator
3description: '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," "API overview," "developer landing," "API marketing," or "API for developers." Note: API documentation (endpoint reference) lives in docs; use docs-page-generator.'
4metadata:
5 version: 1.0.1
6---
7
8# Pages: API Introduction
9
10Guides 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.
11
12**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.
13
14## Initial Assessment
15
16**Check for project context first:** If `.claude/project-context.md` or `.cursor/project-context.md` exists, read it for product and developer use cases.
17
18Identify:
191. **API type**: REST, GraphQL, etc.
202. **Audience**: Developers (integration) vs. decision makers (evaluation)
213. **Docs location**: Where API documentation lives (e.g. `/docs`, `/api/reference`, external)
22
23## Page Role
24
25- **API page** (`/api`): Introduction, overview, value prop, CTA to docs or signup
26- **API documentation**: Lives in docs (docs.*) → API Reference section with endpoint reference, auth, examples
27
28## Best Practices
29
30### Overview and Structure
31
32- **What the API does**: Clear value proposition, key capabilities
33- **Use cases**: Who uses it, common scenarios
34- **Getting started**: Quick path to first call or docs
35- **Link to docs**: Prominent CTA to API documentation
36
37### Content
38
39- **Key concepts**: High-level, not endpoint-level detail
40- **Auth overview**: How auth works; link to docs for details
41- **Pricing/limits**: If relevant for evaluation
42- **SDKs and tools**: If available; link to docs
43
44### SEO and Discovery
45
46- **Developer search**: Target "API" + product/category terms
47- **Metadata**: Title, description for developer intent
48- **Internal links**: From homepage, features, resources
49
50## Output Format
51
52- **Structure** outline (sections)
53- **Value proposition** and key messages
54- **CTA** to documentation or signup
55- **SEO** metadata for developer search
56
57## Related Skills
58
59- **homepage-generator**: Link to API page for developers
60- **schema-markup**: WebPage or SoftwareApplication schema
61- **title-tag, meta-description, page-metadata**: API page metadata
kostja94