stacks-docs

Automate VitePress-based documentation setup and maintenance for Stacks projects.

622|17|Updated Apr 26, 2022
One-click install
npx skills add https://github.com/stacksjs/stacks --skill stacks-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: stacks-docs
Source: https://github.com/stacksjs/stacks/tree/main/.claude/skills/stacks-docs
Command: npx skills add https://github.com/stacksjs/stacks --skill stacks-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation setup and maintenance for Stacks projects can be tedious, requiring manual configuration of docs structure, VitePress integration, and consistency across repos.

Core Features & Use Cases

  • VitePress-based docs setup: Initialize and configure docs for Stacks projects with standard defaults.
  • Documentation structure tooling: Define and enforce consistent docs layout, navigation, and theming.
  • Framework integration: Align docs with the @stacksjs/docs package and project folders like docs/, storage/framework/docs, and config/docs.ts.

Quick Start

Install and configure the Stacks docs package to bootstrap a VitePress docs site for your Stacks project.

Frequently Asked Questions about stacks-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up VitePress documentation for a Stacks project?

To configure VitePress for Stacks, the tooling applies frontmatter-driven metadata and standard defaults, integrating with the docs/ directory, storage/framework/docs, and config/docs.ts to deliver a ready-to-use documentation site.

How does frontmatter-driven metadata work in Stacks documentation?

Frontmatter-driven metadata conforms to VitePress configuration and project-wide docs conventions, ensuring consistent documentation structures and ready-to-use defaults across multiple Stacks projects.

What is the best way to maintain consistent docs structure across multiple Stacks repositories?

Maintaining consistent docs structure is achieved by conforming to frontmatter-driven metadata and VitePress configuration, enforcing standard defaults across repos to deliver ready-to-use documentation.

Do I need the @stacksjs/docs package to configure documentation structure?

Configuring documentation structure aligns with the @stacksjs/docs package, using project folders like docs/, storage/framework/docs, and config/docs.ts to enforce consistent VitePress defaults.

Can I customize VitePress navigation and theming defaults for Stacks docs?

VitePress navigation and theming defaults are customizable through the config/docs.ts file, enabling consistent layout and structure across Stacks project documentation sites.

Why does manual documentation setup cause issues in Stacks projects?

Manual setup causes inconsistency across repos because it lacks standardized VitePress integration and frontmatter-driven metadata, which automation solves by enforcing project-wide docs conventions.