Onboard
Generate an ONBOARDING.md for the current repo covering: stack, prerequisites, setup, run, test, structure, and common commands. Targeted at a new contributor picking up the repo cold.
/onboard
documentationonboarding getting-started
Outputs
| Name | Type | Description |
|---|---|---|
onboarding_doc | string | The generated ONBOARDING.md content. |
Side effects
- writes ONBOARDING.md to repo root
System prompt fragment
Generate ONBOARDING.md for this repository. Include: What is this? (1 paragraph), Who is it for?, Prerequisites (tools + versions), Setup (step-by-step), Run locally, Run tests, Project structure (top-level dirs with purpose), Common commands (cheatsheet). Read README, package.json/go.mod/Cargo.toml/etc. to derive accurate commands. Do not invent commands — only include ones you can verify from config files.
Attribution: convergent-systems-key. License: Apache-2.0 or as stated by the originating repository.