Files
claude-skills-reference/docs/skills/engineering/codebase-onboarding.md
Reza Rezvani 2f57ef8948 feat(agenthub): add AgentHub plugin with cross-domain examples, SEO optimization, and docs site fixes
- AgentHub: 13 files updated with non-engineering examples (content drafts,
  research, strategy) — engineering stays primary, cross-domain secondary
- AgentHub: 7 slash commands, 5 Python scripts, 3 references, 1 agent,
  dry_run.py validation (57 checks)
- Marketplace: agenthub entry added with cross-domain keywords, engineering
  POWERFUL updated (25→30), product (12→13), counts synced across all configs
- SEO: generate-docs.py now produces keyword-rich <title> tags and meta
  descriptions using SKILL.md frontmatter — "Claude Code Skills" in site_name
  propagates to all 276 HTML pages
- SEO: per-domain title suffixes (Agent Skill for Codex & OpenClaw, etc.),
  slug-as-title cleanup, domain label stripping from titles
- Broken links: 141→0 warnings — new rewrite_skill_internal_links() converts
  references/, scripts/, assets/ links to GitHub source URLs; skills/index.md
  phantom slugs fixed (6 marketing, 7 RA/QM)
- Counts synced: 204 skills, 266 tools, 382 refs, 16 agents, 17 commands,
  21 plugins — consistent across CLAUDE.md, README.md, docs/index.md,
  marketplace.json, getting-started.md, mkdocs.yml
- Platform sync: Codex 163 skills, Gemini 246 items, OpenClaw compatible

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-03-17 12:10:46 +01:00

2.9 KiB

title, description
title description
Codebase Onboarding — Agent Skill for Codex & OpenClaw Codebase Onboarding. Agent skill for Claude Code, Codex CLI, Gemini CLI, OpenClaw.

Codebase Onboarding

:material-rocket-launch: Engineering - POWERFUL :material-identifier: `codebase-onboarding` :material-github: Source
Install: claude /plugin install engineering-advanced-skills

Tier: POWERFUL
Category: Engineering
Domain: Documentation / Developer Experience


Overview

Analyze a codebase and generate onboarding documentation for engineers, tech leads, and contractors. This skill is optimized for fast fact-gathering and repeatable onboarding outputs.

Core Capabilities

  • Architecture and stack discovery from repository signals
  • Key file and config inventory for new contributors
  • Local setup and common-task guidance generation
  • Audience-aware documentation framing
  • Debugging and contribution checklist scaffolding

When to Use

  • Onboarding a new team member or contractor
  • Rebuilding stale project docs after large refactors
  • Preparing internal handoff documentation
  • Creating a standardized onboarding packet for services

Quick Start

# 1) Gather codebase facts
python3 scripts/codebase_analyzer.py /path/to/repo

# 2) Export machine-readable output
python3 scripts/codebase_analyzer.py /path/to/repo --json

# 3) Use the template to draft onboarding docs
# See references/onboarding-template.md

  1. Run scripts/codebase_analyzer.py against the target repository.
  2. Capture key signals: file counts, detected languages, config files, top-level structure.
  3. Fill the onboarding template in references/onboarding-template.md.
  4. Tailor output depth by audience:
    • Junior: setup + guardrails
    • Senior: architecture + operational concerns
    • Contractor: scoped ownership + integration boundaries

Onboarding Document Template

Detailed template and section examples live in:

  • references/onboarding-template.md
  • references/output-format-templates.md

Common Pitfalls

  • Writing docs without validating setup commands on a clean environment
  • Mixing architecture deep-dives into contractor-oriented docs
  • Omitting troubleshooting and verification steps
  • Letting onboarding docs drift from current repo state

Best Practices

  1. Keep setup instructions executable and time-bounded.
  2. Document the "why" for key architectural decisions.
  3. Update docs in the same PR as behavior changes.
  4. Treat onboarding docs as living operational assets, not one-time deliverables.