repo-wiki-index

repo-wiki-index

Build a searchable code map of the repository. Extracts modules, components, APIs, configs, dependencies, and key symbols for documentation and citation purposes.

1estrellas
0forks
Actualizado 1/17/2026
SKILL.md
readonlyread-only
name
repo-wiki-index
description

Build a searchable code map of the repository. Extracts modules, components, APIs, configs, dependencies, and key symbols for documentation and citation purposes.

version
1.0.0

Repo Wiki Index Skill

Build a comprehensive code map for documentation generation and citation.

Purpose

This skill creates a searchable index of the codebase that includes:

  1. File inventory (with ignore patterns applied)
  2. Module and component boundaries
  3. Public interfaces (classes, functions, APIs)
  4. Configuration files and their locations
  5. Dependencies and imports
  6. Key entrypoints

When to Use

Use this skill:

  • After running repo-wiki-initialize
  • Before generating page content
  • When the codebase structure has changed significantly

Step-by-Step Instructions

Step 1: Load Configuration

STATE_FILE=".repo_wiki/state.json"

Step 2: Enumerate Files

find . -type f ! -path "./.git/*" ! -path "*/node_modules/*" > .repo_wiki/file_list.txt

Step 3: Detect Technology Stack

Scan for language markers (package.json, requirements.txt, go.mod, etc.)

Step 4: Identify Components

Map directory structure to logical components in src/, lib/, packages/.

Step 5: Extract Public Interfaces

Find exported functions, classes, and APIs for each language.

Step 6: Build Code Index

Create .repo_wiki/code_index.json with all findings.

Output Files

  • .repo_wiki/code_index.json - Main structured index
  • .repo_wiki/file_list.txt - All indexed files
  • .repo_wiki/components.txt - Component detection results
  • .repo_wiki/tech_stack.txt - Technology detection

Success Criteria

  • code_index.json created
  • ✅ Technology stack detected
  • ✅ Components mapped
  • ✅ Entrypoints identified

Next Steps

After indexing:

  1. Generate page content: Read repo-wiki-generate/SKILL.md

You Might Also Like

Related Skills

update-docs

update-docs

137Kdev-docs

This skill should be used when the user asks to "update documentation for my changes", "check docs for this PR", "what docs need updating", "sync docs with code", "scaffold docs for this feature", "document this feature", "review docs completeness", "add docs for this change", "what documentation is affected", "docs impact", or mentions "docs/", "docs/01-app", "docs/02-pages", "MDX", "documentation update", "API reference", ".mdx files". Provides guided workflow for updating Next.js documentation based on code changes.

vercel avatarvercel
Obtener
docstring

docstring

97Kdev-docs

Write docstrings for PyTorch functions and methods following PyTorch conventions. Use when writing or updating docstrings in PyTorch code.

pytorch avatarpytorch
Obtener
docs-writer

docs-writer

94Kdev-docs

Always use this skill when the task involves writing, reviewing, or editing files in the `/docs` directory or any `.md` files in the repository.

google-gemini avatargoogle-gemini
Obtener
write-concept

write-concept

66Kdev-docs

Write or review JavaScript concept documentation pages for the 33 JavaScript Concepts project, following strict structure and quality guidelines

leonardomso avatarleonardomso
Obtener
resource-curator

resource-curator

66Kdev-docs

Find, evaluate, and maintain high-quality external resources for JavaScript concept documentation, including auditing for broken and outdated links

leonardomso avatarleonardomso
Obtener
doc-coauthoring

doc-coauthoring

47Kdev-docs

Guide 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.

anthropics avataranthropics
Obtener