Coding · Intermediate
Draft documentation for an existing codebase
A starter map of a repository for new contributors.
- When you askYou name a repo
- ThenReads folders and modules
- ResultOne paragraph per area
Have a bot walk a repository and draft short explanations of each folder and main module so new contributors have a starting map.
Prompt to start with
BotBentoRecommended
Read the repository and write one short paragraph per top-level folder and main module: what it does and where to start. Mark anything you inferred rather than read.
Muse CodeSetup sketch
Run muse in the project directory, then ask: Read the repository and write one short paragraph per top-level folder and main module: what it does and where to start. Mark anything you inferred rather than read.
Muse Code is Meta's terminal and CI coding agent; its docs describe planning, editing and running commands with approvals. Docs