Repo-Docs helps technical leads and architects standardize repository onboarding by building a reader model of the codebase. It identifies the core problem a project solves, maps specific behaviors to their underlying concepts, and locates where those responsibilities reside in the code.
The skill automates the generation and synchronization of architecture guides, ensuring that documentation remains aligned with the repository as code changes occur.
Follow the documented setup, then try a first task.
Installs: Installs both repo-docs and repo-docs-zh into the user's agent skill directory. · coding agent
Enter the following natural-language request in the coding-agent session: “Install the repo-docs skill from this project: https://github.com/YurunChen/repo-docs-skills Make both repo-docs and repo-docs-zh available in my agent skill directory.”
Installs: Installs both repo-docs and repo-docs-zh, using existing known agent skill directories or the Codex default when none exist. · Codex, Claude, agents
Platform: A platform with curl and Bash
Run this command in a terminal. The supplied GitHub URL redirects to the raw installation script.
curl -fsSL https://github.com/YurunChen/repo-docs-skills/raw/main/install.sh | bash
Installs: Installs the repo-docs and repo-docs-zh package through the documented PowerShell installer. · Codex, Claude, agents
Platform: Windows PowerShell
Run this command in a PowerShell terminal.
irm https://github.com/YurunChen/repo-docs-skills/raw/main/install.ps1 | iex
Installs: Installs both repo-docs and repo-docs-zh using automatic agent-directory selection. · Codex, Claude, agents
Platform: A platform with Bash
Run from: Root of the local repo-docs-skills source checkout
Open a terminal in the root of the current source checkout, then run the installer.
./install.sh
Installs: Installs both repo-docs and repo-docs-zh into all three known locations: ~/.codex/skills, ~/.claude/skills, and ~/.agents/skills. · Codex, Claude, agents
Platform: A platform with Bash
Run from: Root of the local repo-docs-skills source checkout
Open a terminal in the source checkout and run the installer with the documented all-agents flag.
./install.sh --agent all
Installs: Installs both repo-docs and repo-docs-zh into the explicitly documented ~/.agents/skills parent directory. · agents
Platform: A platform with Bash
Run from: Root of the local repo-docs-skills source checkout
Open a terminal in the source checkout and run the installer targeting the documented ~/.agents/skills directory.
./install.sh --target ~/.agents/skills
Uses repo-docs
Use the repo-docs skill to create docs for this repository.
Claude
Codex
Amp