generate-overview

Generate project overview docs from strategy files and codebase.

Updated Apr 17, 2026
One-click install
npx skills add https://github.com/David-Melo/astro-base --skill generate-overview
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: generate-overview
Source: https://github.com/David-Melo/astro-base/tree/main/.claude/skills/generate_overview
Command: npx skills add https://github.com/David-Melo/astro-base --skill generate-overview

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Generates and refreshes the project's documentation set by translating strategy documents and the current codebase into up-to-date, handoff-ready materials for development and governance teams.

Core Features & Use Cases

  • Generate docs/project_overview.md with a concise tech stack and project structure summary.
  • Generate docs/site_overview.md with an implementation snapshot and handoff context.
  • Update the root README.md to reflect developer setup, scripts, and contribution guidelines.
  • Respect source-of-truth: strategy_blueprint.md and brand_palette.md remain authoritative and must not be overwritten.

Quick Start

Run the generate-overview skill after updating strategy_blueprint.md or the codebase to refresh project overview documentation.

Frequently Asked Questions about generate-overview

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

FAQPage Schema
How do I generate project overview documentation from my codebase and strategy files?

You can generate project overview documentation by running the skill to compile concise, developer-friendly handoff materials from your strategy_blueprint.md and current codebase into files like docs/project_overview.md.

What is the best way to automate README and markdown handoff docs for a development team?

Automating markdown handoff docs is best handled by tools that translate strategy documents and the codebase into up-to-date materials, refreshing the root README.md with developer setup, scripts, and contribution guidelines.

Does generating project overview markdown overwrite my strategy_blueprint.md source file?

Generating project overview markdown does not overwrite your strategy_blueprint.md or brand_palette.md files, as the skill preserves these strategy documents as the primary authoritative sources.

When do I need to refresh my site overview and project documentation?

You need to refresh site overview and project documentation whenever you update the strategy_blueprint.md or modify the codebase, ensuring your handoff materials reflect the current implementation snapshot.

Can I use this approach to update developer setup scripts and contribution guidelines in my README?

Yes, you can use this approach to update the root README.md, as the process specifically translates the current codebase context into developer setup instructions, scripts, and contribution guidelines.