← Back to Skills Marketplace
kostja94

docs-page-generator

by Kostja Zhang · GitHub ↗ · v1.0.1 · MIT-0
cross-platform ✓ Security Clean
183
Downloads
0
Stars
0
Active Installs
2
Versions
Install in OpenClaw
/install docs-page-generator
Description
When the user wants to create, optimize, or structure a documentation site. Also use when the user mentions "docs," "documentation site," "docs subdomain," "...
README (SKILL.md)

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
  • content-strategy: Doc content planning
Usage Guidance
This skill looks coherent and self-contained: it generates documentation structure and may read project-context files (.claude/project-context.md or .cursor/project-context.md) if present to tailor outputs. Before installing/using, confirm those project-context files do not contain secrets or private tokens you don't want the agent to read. Also be aware the agent may invoke the skill autonomously (platform default); if you have strict data handling requirements, use it only in sessions with controlled inputs or remove/clean sensitive project-context files first.
Capability Analysis
Type: OpenClaw Skill Name: docs-page-generator Version: 1.0.1 The skill bundle consists of metadata and markdown instructions (SKILL.md) designed to guide an AI agent in generating documentation site structures. It contains no executable code, network requests, or malicious instructions, and its behavior is entirely consistent with its stated purpose of documentation generation.
Capability Assessment
Purpose & Capability
Name and description (docs-site authoring/structure) align with the SKILL.md guidance. The instructions focus on structuring docs, nav, onboarding, and API reference content — all coherent with the stated purpose.
Instruction Scope
Runtime instructions are limited prose for generating docs structure and best practices. They explicitly instruct the agent to read project context files if present (.claude/project-context.md or .cursor/project-context.md), which is reasonable for tailoring output but does require access to repository/project files. The instructions do not ask for arbitrary system files, environment variables, network exfiltration, or credentials.
Install Mechanism
No install spec or code files are included (instruction-only), so nothing is written to disk or downloaded during install.
Credentials
The skill requires no environment variables, credentials, or config paths. Requested resources (the two optional project-context files) are proportional to the task.
Persistence & Privilege
Skill flags show no forced persistence (always: false). It is user-invocable and may be invoked autonomously by the agent by default, which is the platform norm; the skill does not request extra privileges or modify other skills.
How to Use
  1. Make sure OpenClaw is installed (local or Docker)
  2. Run the install command in chat: /install docs-page-generator
  3. After installation, invoke the skill by name or use /docs-page-generator
  4. Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.0.1
Batch: blog through glossary
v1.0.0
Automated batch sync
Metadata
Slug docs-page-generator
Version 1.0.1
License MIT-0
All-time Installs 0
Active Installs 0
Total Versions 2
Frequently Asked Questions

What is docs-page-generator?

When the user wants to create, optimize, or structure a documentation site. Also use when the user mentions "docs," "documentation site," "docs subdomain," "... It is an AI Agent Skill for Claude Code / OpenClaw, with 183 downloads so far.

How do I install docs-page-generator?

Run "/install docs-page-generator" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.

Is docs-page-generator free?

Yes, docs-page-generator is completely free, licensed under MIT-0. You can download, install and use it at no cost.

Which platforms does docs-page-generator support?

docs-page-generator is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).

Who created docs-page-generator?

It is built and maintained by Kostja Zhang (@kostja94); the current version is v1.0.1.

💬 Comments