setup-docs

Analyze a codebase and populate .chalk/docs PROFILE stubs.

6|Updated Feb 19, 2026
One-click install
npx skills add https://github.com/jerelvelarde/chalk-skills --skill setup-docs-jerelvelarde
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: setup-docs
Source: https://github.com/jerelvelarde/chalk-skills/tree/main/skills/setup-docs
Command: npx skills add https://github.com/jerelvelarde/chalk-skills --skill setup-docs-jerelvelarde

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically populate and enrich the project's Chalk documentation stubs (.chalk/docs) by deeply analyzing the codebase and aligning chalk.json with real project content.

Core Features & Use Cases

  • Populates all PROFILE stubs under .chalk/docs with real content derived from the codebase (product, engineering, AI).
  • Enriches chalk.json with missing fields such as routes, sourceLayout, and dev/test configuration.
  • Preserves existing content while enhancing stubs and templates, facilitating faster project onboarding.

Quick Start

Run the setup-docs workflow after you generate the initial Chalk scaffolds to populate all PROFILE stubs with real content.

Frequently Asked Questions about setup-docs

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

FAQPage Schema
How do I automatically populate Chalk documentation stubs from my codebase?

To populate Chalk profile docs, run the setup-docs workflow after generating initial scaffolds; it analyzes the codebase and updates .chalk/docs stubs with real content. This bootstraps product, engineering, and AI documentation automatically.

What's the best way to bootstrap project documentation for an existing codebase?

The best way to bootstrap project documentation is using an automated workflow that deeply analyzes the codebase and populates documentation stubs. This ensures the generated product, engineering, and AI docs reflect real project content.

Does the setup-docs workflow update chalk.json with detected project fields?

Yes, the setup-docs workflow updates chalk.json with detected fields such as routes, sourceLayout, and dev/test configuration. It enriches the configuration file while preserving existing content.

What do I need to run an automated documentation bootstrap for Chalk profiles?

You need access to the codebase, a chalk.json file, and existing PROFILE stubs under .chalk/docs. The workflow analyzes these inputs to update the configuration and populate the documentation with real content.

Can I preserve existing content while enriching documentation stubs?

Yes, the workflow preserves existing content while enhancing stubs and templates. It populates the Chalk profile docs by adding real content derived from the codebase without overwriting previous documentation.