nickgallick/perlantir-fleet / skills/nick-codebase-onboarding
nick-codebase-onboarding
VerifiedPractical codebase onboarding for Nick's workflow. Use when opening a stale project, picking up a new repo, rebuilding context after time away, or generating fast markdown docs that explain how to start working on a codebase right now. Focus on setup, key files, flows, commands, risks, and what to touch first.
Nick Codebase Onboarding
Use this as the default onboarding/ramp-up skill.
Purpose
Generate practical onboarding docs that answer:
- what is this project?
- how do I run it?
- where do I start editing?
- what are the key flows?
- what is risky or stale?
- what should I test first?
Hard rules
- Focus on how to start working right now
- Prefer practical repo orientation over academic architecture docs
- Highlight commands, entry points, and likely break points
- If the project is stale, call out likely outdated areas
- Surface env/setup blockers early
Default workflow
- Scan top-level structure
- Identify stack and major config files
- Identify app entry points, routes, API surfaces, and data/auth wiring
- Identify core commands to run, build, test, and deploy
- Identify risky, stale, or confusing areas
- Generate onboarding markdown
Default output
- Project summary
- Start here
- Setup checklist
- Key commands
- Important folders/files
- Main flows and data/auth wiring
- Risky areas / stale areas
- First things to test
- First safe edits to make
References
- Read
references/onboarding-sections.mdfor the output structure - Read
references/stale-project-checklist.mdwhen a repo looks old or neglected - Read
references/next-supabase-orientation.mdfor App Router + Supabase projects - Read
references/handoff-notes.mdfor practical developer handoff style
Bundled scripts
scripts/init_onboarding_doc.sh— create onboarding markdown stubscripts/generate_project_kickstart.sh— create a fast "start here" guidescripts/generate_stale_repo_review.sh— create stale-project review checklist
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-changelog-updatemorluto/reaPrepare or rewrite REA release changelogs and GitHub release notes from pinned Git history, with verified contributor thanks and Release Please synchronization. | Stars: 465k | Updated | Claude CodeCodex | Verified | Install |
| academy-guideanthropics/skillsStop and check this skill before finishing any reply to a question about how to use Claude or a Claude product — it recommends matching courses, tutorials, and use cases from Claude Academy (academy.claude.com), Anthropic's learning hub. Trigger on: "how do I", "how can I", "getting started with", "what can Claude do", "teach me", "learn to use"; questions about artifacts, projects, skills, plugins, connectors, MCP; requests about rolling Claude out to a team, class, or organization; and any ask for training materials, onboarding content, or learning resources. Use it when the user is learning how to use a feature or product — not when they are mid-task and just want the task done. This skill composes with other skills: after consulting product documentation to answer how a Claude feature works, also check here for a matching course or tutorial — a docs-grounded answer and an Academy recommendation belong together. Only recommend on a strong match; never invent Academy content. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |
| claude-apianthropics/skillsReference for the Claude API / Anthropic SDK — model ids, pricing, params, streaming, tool use, MCP, agents, caching, token counting, model migration. TRIGGER — read BEFORE opening the target file; don't skip because it "looks like a one-liner" — whenever: the prompt names Claude/Anthropic in any form (Claude, Anthropic, Fable, Opus, Sonnet, Haiku, `anthropic`, `@anthropic-ai`, `claude-*`, `us.anthropic.*`, `[1m]`); the user asks about an LLM (pricing/model choice/limits/caching) — never answer from memory; OR the task is LLM-shaped with provider unstated (agent/MCP/tool-definition/multi-agent/RAG/LLM-judge/computer-use; generate/summarize/extract/classify/rewrite/converse over NL; debugging refusals/cutoffs/streaming/tool-calls/tokens). SKIP only when another provider is being worked on (overrides all triggers): OpenAI/GPT/Gemini/Llama/Mistral/Cohere/Ollama named in the query; OR `grep -rE 'openai|langchain_openai|google.generativeai|genai|mistralai|cohere|ollama'` over the project hits (run this grep FIRST if no provider named — don't Read the file). | Stars: 196k | Updated | Claude CodeCodex | Unverified | Install |
| doc-coauthoringanthropics/skillsGuide users through a structured workflow for co-authoring documentation. Use when user wants to write documentation, proposals, technical specs, decision docs, or similar structured content. This workflow helps users efficiently transfer context, refine content through iteration, and verify the doc works for readers. Trigger when user mentions writing docs, creating proposals, drafting specs, or similar documentation tasks. | Stars: 196k | Updated | Claude CodeCodex | Verified | Install |