You are producing or refreshing onboarding documentation so another developer can work on this repository without tribal knowledge.
Custom instructions: If the user included extra instructions when invoking this skill, treat them as overriding or extending the guidance below.
Read:
.docs/seed.md — what the product is (short orientation).docs/tech-stack.md — tools, versions, key commandsREADME.md — what exists today- Repo:
package.json scripts, Makefile, Docker files, CI workflow, .nvmrc / toolchain files
Your task:
Update or create concise onboarding content. Prefer improving README.md sections unless the user asks for CONTRIBUTING.md or .docs/onboarding.md.
Cover only what applies:
- Prerequisites — Runtime versions, package manager, optional CLI tools.
- First run — Clone, install, env file from example, database/setup migrations if any, command to start dev.
- Project map — Where features, UI, API, tests, and docs live (high level).
- Conventions — Branching, commits, lint/test before PR, how design tokens and the design system doc relate to code.
- Common tasks — Run tests, typecheck, build, storybook/showcase if present.
- Where to ask — Point to backlog, seed, or team channel if mentioned in docs.
RULES:
- Do not invent scripts that do not exist; read
package.json / CI / Makefile first.
- Keep README accurate: replace placeholder “Project Name” / generic text only if you have seed content to substitute.
- After edits, the README should answer “how do I run this?” in under two minutes of reading.
Logging: On success, append to .docs/changelog.md per .docs/changelog-spec.md: - YYYY-MM-DD HH:mm ran /onboard — [brief summary].
1---2name: onboard3description: Produce or refresh onboarding docs and README so another dev can run and contribute. Use only when the user explicitly asks to refresh onboarding docs or runs /onboard.4---56You are producing or refreshing **onboarding documentation** so another developer can work on this repository without tribal knowledge.78**Custom instructions:** If the user included extra instructions when invoking this skill, treat them as overriding or extending the guidance below.910**Read:**1112- `.docs/seed.md` — what the product is (short orientation)13- `.docs/tech-stack.md` — tools, versions, key commands14- `README.md` — what exists today15- Repo: `package.json` scripts, `Makefile`, Docker files, CI workflow, `.nvmrc` / toolchain files1617**Your task:**1819Update or create concise onboarding content. Prefer improving **README.md** sections unless the user asks for `CONTRIBUTING.md` or `.docs/onboarding.md`.2021Cover only what applies:22231. **Prerequisites** — Runtime versions, package manager, optional CLI tools.242. **First run** — Clone, install, env file from example, database/setup migrations if any, command to start dev.253. **Project map** — Where features, UI, API, tests, and docs live (high level).264. **Conventions** — Branching, commits, lint/test before PR, how design tokens and the design system doc relate to code.275. **Common tasks** — Run tests, typecheck, build, storybook/showcase if present.286. **Where to ask** — Point to backlog, seed, or team channel if mentioned in docs.2930**RULES:**3132- Do not invent scripts that do not exist; read `package.json` / CI / Makefile first.33- Keep README accurate: replace placeholder “Project Name” / generic text only if you have seed content to substitute.34- After edits, the README should answer “how do I run this?” in under two minutes of reading.3536**Logging:** On success, append to `.docs/changelog.md` per `.docs/changelog-spec.md`: `- YYYY-MM-DD HH:mm ran /onboard — [brief summary]`.
limonequantistico