Docs Page Generator
Plan docs subdomain structure, navigation, and content types—from Getting Started through API Reference—for products solo builders ship.
Overview
Docs Page Generator is an agent skill most often used in Build (also Launch, Grow) that structures documentation sites including Getting Started, guides, tutorials, and API Reference.
Install
npx skills add https://github.com/kostja94/marketing-skills --skill docs-page-generatorWhat is this skill?
- Assessment: product type, audience (users, developers, admins), content sources (Markdown, MDX, Git, CMS), docs.* vs hel
- Section map: Getting Started, guides, tutorials, API Reference, troubleshooting
- Explicit boundary: API endpoint reference here vs API introduction marketing via api-page-generator
- Reads project-context.md from Claude or Cursor when present
- First-use intro optional; subsequent runs can skip straight to structure output
Adoption & trust: 741 installs on skills.sh; 586 GitHub stars; 3/3 security scanners passed (skills.sh audits).
What problem does it solve?
You need a docs or help subdomain but only have fragmented markdown and no clear IA for onboarding, guides, and API reference.
Who is it for?
Indie devs launching SaaS or APIs who want a sensible docs IA before choosing Docusaurus, Mintlify, or similar.
Skip if: API product marketing landing pages—use api-page-generator; not a substitute for writing individual tutorial prose end-to-end.
When should I use this skill?
User wants to create, optimize, or structure a documentation site, or mentions docs, documentation site, docs subdomain, help center, knowledge base, Getting Started, API Reference, user guides, or tutorials.
What do I get? / Deliverables
You get an assessed docs topology and section-purpose table aligned to your audience and content sources, ready to implement on docs.* or help.* without conflating API marketing pages.
- Documentation section structure table
- Hosting and subdomain recommendation
- Content organization aligned to guides and API Reference
Recommended Skills
Journey fit
Spans multiple journey phases - primary shelf plus alternate fits below.
Documentation sites are built alongside the product; canonical placement is Build/docs, while finished docs support Launch GEO and Grow support deflection. Docs subphase covers help centers, knowledge bases, and developer documentation architecture distinct from API marketing landings.
Where it fits
Define Getting Started, guides, and API Reference slots before scaffolding a Docusaurus repo.
Align troubleshooting and tutorial headings with how-to queries you want indexed.
Extend the section map with FAQ and troubleshooting to reduce ticket volume.
How it compares
Documentation site planner and section taxonomy, not an API splash-page generator or OpenAPI linter.
Common Questions / FAQ
Who is docs-page-generator for?
Solo builders and small teams creating or reorganizing docs.yourdomain.com-style sites for software, APIs, or services.
When should I use docs-page-generator?
In Build when standing up docs IA; at Launch when optimizing help content for discovery; in Grow when expanding troubleshooting and guides—when you mention docs site, help center, or API Reference structure.
Is docs-page-generator safe to install?
It is structural documentation guidance with optional reads of local project-context files; review the Security Audits panel on this catalog page before installing.
SKILL.md
READMESKILL.md - Docs Page Generator
# Pages: Documentation Site Guides documentation site structure, navigation, and content organization. Typically hosted on `docs.*` or `help.*` subdomain. Includes Getting Started, guides, tutorials, **API Reference** (endpoint docs), and troubleshooting. Distinct from API introduction page (api-page-generator). **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, audience, and use cases. Identify: 1. **Product type**: Software, API, hardware, service 2. **Audience**: End users, developers, admins 3. **Content sources**: Markdown, MDX, Git, CMS 4. **Subdomain**: docs.*, help.*, or path (/docs) ## Documentation Structure | Section | Purpose | Typical Content | |---------|---------|-----------------| | **Getting Started** | Onboarding, first steps | Quick start, installation, first task | | **Guides / Tutorials** | Step-by-step learning | How-to articles, workflows | | **Concepts** | Background, architecture | Key concepts, glossary links | | **API Reference** | Endpoint docs | Auth, request/response, examples; part of docs, not separate page | | **Troubleshooting** | Problem solving | FAQ, common errors, support links | ## Best Practices ### Information Architecture - **Progressive disclosure**: Start simple, link to depth - **Sidebar navigation**: Hierarchical, collapsible sections - **Search**: Full-text search for long doc sets - **Breadcrumbs**: For deep hierarchies ### API Reference (within Docs) API Reference is a section of docs, not a standalone page. Include: endpoints by resource, auth, request/response schemas, error codes, rate limits, code examples (cURL, SDKs). Use OpenAPI/Swagger for consistency. ### Content - **Task-oriented**: "How to X" not "X feature" - **Code examples**: Copy-paste ready, multiple languages if relevant - **Screenshots/videos**: For UI-heavy products - **Versioning**: Document product/API version when applicable ### SEO and Discovery - **Index docs**: Unless internal-only; use robots if needed - **Internal links**: Cross-link related articles, link to main site - **Schema**: TechArticle, HowTo for guides ## Output Format - **Structure** (sections, hierarchy) - **Navigation** design (sidebar, top-level) - **Getting Started** outline - **Content** checklist per section - **Subdomain/path** recommendation ## Related Skills - **api-page-generator**: API intro page links to docs - **sidebar-generator**: Docs sidebar design - **faq-page-generator**: FAQ can live in docs or main site - **howto-section-generator**: HowTo step blocks in guides/tutorials; TechArticle + HowTo alignment - **content-strategy**: Doc content planning