Onboarding Guide
Generate a new developer onboarding guide from project docs and READMEs
Example Prompt
Generate an onboarding guide for new developers joining our project based on the existing docs and project structure
About
Creates a comprehensive onboarding guide for new developers by scanning the project's documentation, README files, and directory structure. Synthesizes setup instructions, architecture overviews, and key workflows into a single reference document stored in the repository.
Workflow Steps
List the project directory structure to understand the codebase layout
📁 List DirectoryRead existing README and documentation files for setup and architecture info
📄 Read FileRead key configuration files from the repository for environment setup details
📃 Read Repo FileReason through and organize the information into a logical onboarding flow
🧠 Structured ReasoningWrite the generated onboarding guide to the project docs directory
✏️ Write FileTools Used
List Directory
List all files and subdirectories in a given directory path
Read File
Read the contents of a file at a specified path on the local filesystem
Write File
Write or overwrite a file at a specified path with the given content
Read Repo File
Read the contents of a file from a GitHub repository at a specific branch or commit
Structured Reasoning
Break down a complex problem into sequential reasoning steps with explicit chain-of-thought