← ClaudeAtlas

uselink-onboardinglisted

Scan a codebase and generate a new-developer onboarding guide as HTML, then publish to uselink. Use when the user wants to create a getting-started guide, onboard a new team member, or share 'how to work in this repo' docs.
compilet-dev/agent-skill-uselink · ★ 2 · AI & Automation · score 76
Install: claude install-skill compilet-dev/agent-skill-uselink
# Onboarding Guide → Uselink Scan a codebase, generate a comprehensive getting-started guide for new developers, and publish it to uselink as a shareable link. ## When to Use - "Create an onboarding guide for the new hire" - "How do I explain this repo to someone new? Publish it." - "Generate a getting-started doc and share it" - "Make a dev setup guide I can send to contractors" ## Prerequisites ```bash which uselink || echo "MISSING" test -f ~/.uselink/config.json && echo "OK" || echo "NO_CONFIG" ``` ## Workflow ### 1. Scan the codebase ```bash # Project identity git remote get-url origin 2>/dev/null basename "$(git rev-parse --show-toplevel)" # Build system for f in Makefile package.json build.gradle.kts Cargo.toml go.mod pyproject.toml docker-compose.yml; do test -f "$f" && echo "BUILD: $f" done # Environment files ls .env.example .env.sample .env.template 2>/dev/null ls .tool-versions .node-version .java-version .python-version .ruby-version 2>/dev/null # Documentation ls README.md CLAUDE.md CONTRIBUTING.md docs/ .github/CONTRIBUTING.md 2>/dev/null # Infrastructure ls Dockerfile docker-compose.yml 2>/dev/null ls .github/workflows/*.yml 2>/dev/null # Directory structure find . -maxdepth 2 -type d -not -path "*/.git*" -not -path "*/node_modules*" -not -path "*/build*" -not -path "*/__pycache__*" | sort ``` ### 2. Read key files Read (first 150 lines of each): - `README.md` — existing setup instructions - `CLAUDE.md` — architecture and conventions - `Makefi