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