Skip to content

Truc350/WebHomeStay / .agents/skills/basedkit-docs-update

basedkit-docs-update

Verified

⚡⚡⚡ Analyze the codebase and update documentation

basedkit-docs-update

Use this skill for the BasedKit command /docs:update.

Phase 1: Parallel Codebase Scouting

  1. Scan the codebase and calculate the number of files with LOC in each directory (skip credentials, cache or external modules directories, such as .claude, .opencode, .git, tests, node_modules, __pycache__, secrets, etc.)
  2. Target directories that actually exist - adapt to project structure, don't hardcode paths
  3. Activate scout skill to explore the code base and return detailed summary reports to the main agent
  4. Main agent merges scout reports into context summary and delegate to docs-manager agent to update documentation (next phase)

Phase 1.5: Parallel Documentation Reading

You (main agent) must spawn readers - subagents cannot spawn subagents.

  1. Count docs: ls docs/*.md 2>/dev/null | wc -l
  2. Get LOC: wc -l docs/*.md 2>/dev/null | sort -rn
  3. Strategy:
    • 1-3 files: Skip parallel reading, docs-manager reads directly
    • 4-6 files: Spawn 2-3 Explore agents
    • 7+ files: Spawn 4-5 Explore agents (max 5)
  4. Distribute files by LOC (larger files get dedicated agent)
  5. Each agent prompt: "Read these docs, extract: purpose, key sections, areas needing update. Files: {list}"
  6. Merge results into context for docs-manager

Workload Distribution Example

AgentFilesEst. LOC
1codebase-summary.md (800)800
2system-architecture.md (400), code-standards.md (300)700
3project-overview-pdr.md (500), project-roadmap.md (200)700

Phase 2: Documentation Update (docs-manager Agent)

Pass the gathered file list to docs-manager agent to update documentation:

  • README.md: Update README (keep it under 300 lines)
  • docs/project-overview-pdr.md: Update project overview and PDR (Product Development Requirements)
  • docs/codebase-summary.md: Update codebase summary
  • docs/code-standards.md: Update codebase structure and code standards
  • docs/system-architecture.md: Update system architecture
  • docs/project-roadmap.md: Update project roadmap
  • docs/deployment-guide.md [optional]: Update deployment guide
  • docs/design-guidelines.md [optional]: Update design guidelines

Additional requests

<additional_requests> {{args}} </additional_requests>

Phase 3: Size Check (Post-Update)

After docs-manager completes:

  1. Run wc -l docs/*.md 2>/dev/null | sort -rn to check LOC
  2. Use docs.maxLoc from session context (default: 800)
  3. For files exceeding limit:
    • Report which files exceed and by how much
    • docs-manager should have already split proactively per Section 6 guidelines
    • If still oversized, ask user: split now or accept as-is?

Phase 4: Documentation Validation (Post-Update)

Run validation to detect potential hallucinations:

  1. Run: node .codex/basedkit/scripts/validate-docs.cjs docs/
  2. Display validation report (warnings only, non-blocking)
  3. Checks performed:
    • Code references: Verify functionName() and ClassName exist in codebase
    • Internal links: Verify [text](./path.md) links point to existing files
    • Config keys: Verify ENV_VAR mentioned in docs exist in .env.example

Important

  • Use docs/ directory as the source of truth for documentation.

IMPORTANT: Do not start implementing.

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: 466kUpdated Claude CodeCodexVerifiedInstall
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: 196kUpdated Claude CodeCodexVerifiedInstall
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: 196kUpdated Claude CodeCodexUnverifiedInstall
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: 196kUpdated Claude CodeCodexVerifiedInstall