wiki-onboarding

Featured

Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase. Use when user asks for onboarding docs or getting-started guides, user runs /deep-wiki, or user wants to help new team members understand a codebase.

AI & Automation 39,227 stars 6374 forks Updated today MIT

Install

View on GitHub

Quality Score: 99/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Wiki Onboarding Guide Generator Generate two complementary onboarding documents that together give any engineer — from newcomer to principal — a complete understanding of a codebase. ## When to Use - User asks for onboarding docs or getting-started guides - User runs `/deep-wiki:onboard` command - User wants to help new team members understand a codebase ## Language Detection Scan the repository for build files to determine the primary language for code examples: - `package.json` / `tsconfig.json` → TypeScript/JavaScript - `*.csproj` / `*.sln` → C# / .NET - `Cargo.toml` → Rust - `pyproject.toml` / `setup.py` / `requirements.txt` → Python - `go.mod` → Go - `pom.xml` / `build.gradle` → Java ## Guide 1: Principal-Level Onboarding **Audience**: Senior/staff+ engineers who need the "why" behind decisions. ### Required Sections 1. **System Philosophy & Design Principles** — What invariants does the system maintain? What were the key design choices and why? 2. **Architecture Overview** — Component map with Mermaid diagram. What owns what, communication patterns. 3. **Key Abstractions & Interfaces** — The load-bearing abstractions everything depends on 4. **Decision Log** — Major architectural decisions with context, alternatives considered, trade-offs 5. **Dependency Rationale** — Why each major dependency was chosen, what it replaced 6. **Data Flow & State** — How data moves through the system (traced from actual code, not guessed) 7. **Failure Modes & Error Handling** — ...

Details

Author
sickn33
Repository
sickn33/antigravity-awesome-skills
Created
4 months ago
Last Updated
today
Language
Python
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category