skills.rest
okwinds
okwindsCOMMUNITY
Explore all skills by this author →
GitHub

repo-deep-dive-report

Generate structured Markdown and HTML repository reviews with Mermaid diagrams.

50|3|Updated Jan 30, 2026
Search Tags:#documentation#Mermaid#repository-analysis#architecture-map#standalone HTML#repo-deep-dive
One-click install
npx skills add https://github.com/okwinds/miscellany --skill repo-deep-dive-report
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: repo-deep-dive-report
Source: https://github.com/okwinds/miscellany/tree/main/agent/skills/repo-deep-dive-report
Command: npx skills add https://github.com/okwinds/miscellany --skill repo-deep-dive-report

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides an end-to-end workflow to read a code repository and produce an evidence-based, structured review as Markdown plus a standalone HTML report, including architecture maps, entrypoint traces, and actionable recommendations.

Core Features & Use Cases

  • Evidence-based reports: generate a comprehensive review of a repo's structure, core abstractions, entrypoints, and extension points.
  • MD+HTML deliverables: produce a portable, offline-friendly report with Mermaid diagrams.
  • Getting started: ideal for onboarding developers or conducting repository audits to communicate findings to stakeholders.

Quick Start

Use the repo-deep-dive workflow on a target repository to generate docs/repo_review.md and docs/repo_review.html. Example:

  • Generate a repo snapshot: python3 agent/skills/repo-deep-dive-report/scripts/repo_snapshot.py --repo . --output docs/_repo_snapshot.md
  • Create the review content in docs/repo_review.md following the outline in references/report_outline.md
  • Render to HTML: python3 agent/skills/repo-deep-dive-report/scripts/render_md_to_html.py --input docs/repo_review.md --output docs/repo_review.html --title "Repo Review"

Frequently Asked Questions about repo-deep-dive-report

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

FAQPage Schema
How do I generate an architecture map and repository analysis report for a codebase?▼

To generate a repository analysis report, you can use a script to snapshot your repo and render a structured Markdown review into a standalone HTML file with Mermaid diagrams. This produces a portable deliverable containing architecture maps, entrypoint traces, and actionable recommendations.

Can I create a standalone HTML report with Mermaid diagrams from a Markdown file?▼

Yes, you can render a Markdown file into a standalone HTML report with Mermaid diagrams by running a Python render script. This converts your structured review content into an offline-friendly, portable HTML deliverable for stakeholders.

What is the best way to automate deep repo reviews for developer onboarding?▼

Automating deep repo reviews involves reading the codebase to extract architecture maps, entrypoints, and extension points, then generating an evidence-based scorecard. This creates a repeatable workflow that helps onboard developers by communicating repository findings clearly.

Does this repository audit workflow work across multiple languages and modules?▼

Yes, the repository audit workflow targets architecture, entrypoints, dependencies, and extension points across languages and modules. It reads your codebase to produce a structured review, ensuring the generated module map and execution traces cover your entire project.

What format are the repository review deliverables saved in?▼

The repository review deliverables are saved as Markdown and standalone HTML files. You generate a repo snapshot in Markdown, structure the review content, and then render it to a portable HTML file to hand to stakeholders.

How do I trace entrypoints and extension points during a repository audit?▼

Tracing entrypoints and extension points during a repository audit requires reading the codebase to identify core abstractions and execution flows. The process generates an evidence-based review containing execution traces and a module map for your project.

Related Skills

Explore More Software Engineering Skills→
14ag14ag

github-raw-reader

Access raw GitHub source files via URL conversion and sparse cloning.

Community
Intermediate
rotnovrotnov

improve-codebase-architecture

Analyze repository code to generate HTML architectural improvement reports.

Community
Advanced
LusciiLuscii

mermaid-diagrams

Embed Mermaid diagrams in Markdown documents for visualizations.

Official
Basic
OneWave-AIOneWave-AI
245

code-review-pro

Review code for security vulnerabilities, performance bottlenecks, and maintainability issues.

Official
Basic