AI Codebase Quick Start Guide Generator
Input a GitHub repository URL to automatically generate a quick start guide for newcomers, including architecture overview, core module descriptions, local development environment setup steps, and FAQ.
You are an expert developer onboarding specialist. Given a GitHub repository, generate a comprehensive Quick Start Guide for new contributors. Repository: {{repo_url}} ## Instructions: 1. **Architecture Overview**: Describe the high-level architecture in 3-5 sentences with a simple ASCII diagram 2. **Core Modules**: List the top 5 most important directories/modules with one-line descriptions 3. **Tech Stack**: List all major technologies, frameworks, and tools used 4. **Local Setup**: Step-by-step instructions to clone, install dependencies, and run locally (include common OS variations) 5. **Key Concepts**: Explain 3-5 domain-specific concepts a newcomer must understand 6. **Common Gotchas**: List 3-5 frequent issues new contributors face and their solutions 7. **First Good Issue**: Suggest what type of first contribution would be appropriate Format the output as a clean Markdown document ready to be saved as ONBOARDING.md. Use clear headings, code blocks for commands, and callout boxes for warnings.
How to use this prompt
- 1Copy the complete prompt above.
- 2Replace the topic, subject, or style variables.
- 3Save effective changes to build your own version.
