skills.rest
UpayanGhosh
UpayanGhoshCOMMUNITY
Explore all skills by this author →
GitHub

tldr

Generate an interactive explainer website with diagrams and code maps from a codebase.

8|1|Updated Mar 27, 2026
Search Tags:#automation#architecture#documentation#mind-map#code-map#repo-tour
One-click install
npx skills add https://github.com/UpayanGhosh/tldr-skill --skill tldr-upayanghosh
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: tldr
Source: https://github.com/UpayanGhosh/tldr-skill/tree/main/repo-tour
Command: npx skills add https://github.com/UpayanGhosh/tldr-skill --skill tldr-upayanghosh

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This skill converts a codebase into an interactive explainer website, enabling non-developers to understand structure, architecture, and dependencies without reading code.

Core Features & Use Cases

  • Generates a living onboarding document for new developers.
  • Produces sections like Overview, Architecture, Code Map, Directory Mind Map, Workflows, and getting started guides.
  • Works with Claude Code, OpenCode, Gemini CLI, Codex CLI for self-hosted deployment.

Quick Start

Provide a repository path and trigger Claude Code to generate an interactive codebase explainer site.

Frequently Asked Questions about tldr

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

FAQPage Schema
How do I generate an interactive codebase tour for new developer onboarding?▼

A codebase tour is an interactive explainer website featuring diagrams, directory mind maps, and guided narratives that help new developers understand project structure without reading source code. It works by analyzing the repository to generate a static index.html site with architectural overviews.

Can I create architecture diagrams and code maps for a polyglot monorepo?▼

Yes, you can create architecture diagrams and code maps for a polyglot monorepo. The tool identifies complex codebase structures across multiple languages and generates sections like overview, architecture, and directory mind maps suitable for diverse repository environments.

Does the generated codebase explainer site work with Claude Code and Gemini CLI?▼

Yes, the generated codebase explainer site works with Claude Code, OpenCode, Gemini CLI, and Codex CLI for self-hosted deployment. It outputs a static index.html site that can be hosted and viewed independently of the generation environment.

What is the best way to document repository workflows and architecture automatically?▼

The best way to document repository workflows automatically is to generate a living onboarding document that includes overview, architecture, code map, and getting started sections. This transforms static code into an interactive narrative without manual writing.

Do I need any dependencies to turn a repo into an explainer website?▼

No, you do not need any external dependencies to turn a repo into an explainer website. The tool operates without dependencies by analyzing the repository and outputting a standalone static site plus sidecar data files.

Related Skills

Explore More Software Engineering Skills→
ibalasiteibalasite

gendoc-update

...

Community
Intermediate
EmasoftEmasoft

amvcp-share-pages

Deploy a self-contained HTML page to Vercel and return a public live URL.

Community
Intermediate
MohammedSaudAlsahliMohammedSaudAlsahli

ccg

Orchestrates CodexCLI, AntigravityCLI/GeminiCLI parallel analysis with Claude synthesis for complex tasks.

Community
Advanced
haJ1thaJ1t

onboarding-automator

Automate developer environment setup and guide first Pull Request submission.

Community
Intermediate