Skip to content

YurunChen/repo-docs-skills / docs

repo-docs

Flagged

Build and maintain a Markdown guide that helps humans understand a repository through real behavior, concepts, and evidence. Use when a user asks to understand a repo, generate or update repo-docs, answer repo-architecture/onboarding questions, seed docs for a new project, sync docs after code changes, or delete generated repo docs.

FileKindSize
.nojekyllother0 B
EXAMPLES.mdmarkdown33.1 KB
PAGE_RULES.mdmarkdown44.2 KB
QUALITY_RULES.mdmarkdown4.8 KB
README.mdmarkdown8.9 KB
README_CN.mdmarkdown8.6 KB
REFERENCE.mdmarkdown1.0 KB
ROOT_AGENT_RULES.mdmarkdown4.2 KB
SCOPE_MODES.mdmarkdown4.9 KB
SKILL.mdskill md12.4 KB
SYNC_RULES.mdmarkdown20.5 KB
WRITING.mdmarkdown15.0 KB
assets/gsap.min.jsscript70.7 KB
assets/logo.pngbinary284.0 KB
assets/main.pngbinary1.9 MB
assets/repo-docs-evidence-atlas.pngbinary2.1 MB
assets/repo-docs-pixel-kingdom.pngbinary2.6 MB
assets/repo-docs-pixel-workshop.pngbinary2.4 MB
assets/site.cssother63.7 KB
assets/site.jsscript38.6 KB
case-studies/aider.mdmarkdown1.2 KB
case-studies/bolt-diy.mdmarkdown1.2 KB
case-studies/generated/aider/repo-docs/README.mdmarkdown3.7 KB
case-studies/generated/aider/repo-docs/change-log.mdmarkdown1.4 KB
case-studies/generated/aider/repo-docs/code-map.mdmarkdown3.5 KB
case-studies/generated/aider/repo-docs/glossary.mdmarkdown3.3 KB
case-studies/generated/aider/repo-docs/modules/edit-lifecycle.mdmarkdown3.1 KB
case-studies/generated/aider/repo-docs/modules/session-assembly.mdmarkdown2.3 KB
case-studies/generated/aider/repo-docs/references/quality-review.mdmarkdown3.7 KB
case-studies/generated/aider/repo-docs/references/source-evidence.mdmarkdown13.0 KB
case-studies/generated/aider/repo-docs/walkthroughs/one-real-run.mdmarkdown10.4 KB
case-studies/generated/bolt-diy/repo-docs/README.mdmarkdown3.9 KB
case-studies/generated/bolt-diy/repo-docs/change-log.mdmarkdown1.5 KB
case-studies/generated/bolt-diy/repo-docs/code-map.mdmarkdown4.1 KB
case-studies/generated/bolt-diy/repo-docs/glossary.mdmarkdown3.5 KB
case-studies/generated/bolt-diy/repo-docs/modules/chat-api-contract.mdmarkdown5.5 KB
case-studies/generated/bolt-diy/repo-docs/modules/chat-stream.mdmarkdown2.7 KB
case-studies/generated/bolt-diy/repo-docs/modules/provider-model-selection.mdmarkdown2.8 KB
case-studies/generated/bolt-diy/repo-docs/references/quality-review.mdmarkdown3.2 KB
case-studies/generated/bolt-diy/repo-docs/references/source-evidence.mdmarkdown11.1 KB
case-studies/generated/bolt-diy/repo-docs/walkthroughs/one-real-run.mdmarkdown8.6 KB
case-studies/generated/tabby/repo-docs/README.mdmarkdown2.6 KB
case-studies/generated/tabby/repo-docs/change-log.mdmarkdown1.7 KB
case-studies/generated/tabby/repo-docs/code-map.mdmarkdown4.4 KB
case-studies/generated/tabby/repo-docs/glossary.mdmarkdown4.3 KB
case-studies/generated/tabby/repo-docs/modules/completion-contract.mdmarkdown9.6 KB
case-studies/generated/tabby/repo-docs/modules/completion-pipeline.mdmarkdown2.3 KB
case-studies/generated/tabby/repo-docs/modules/retrieval-context.mdmarkdown3.2 KB
case-studies/generated/tabby/repo-docs/references/quality-review.mdmarkdown3.2 KB
case-studies/generated/tabby/repo-docs/references/source-evidence.mdmarkdown10.2 KB
case-studies/generated/tabby/repo-docs/walkthroughs/one-real-run.mdmarkdown9.6 KB
case-studies/tabby.mdmarkdown1.2 KB
index.htmlother26.1 KB
scripts/validate_repo_docs.pyexecutablescript46.6 KB
validate_repo_docs.pyscript482 B

case-studies/generated/aider/repo-docs/references/quality-review.md

View on GitHub
# Quality Review

## Reader Simulation

| Reader question | Answer from the guide |
| --- | --- |
| What real path is followed? | A terminal `aider` session creates a configured `Coder`, sends one user message, parses a diff-style SEARCH/REPLACE reply, checks file authority and dirty state, writes the edit, and optionally commits/lints/tests. |
| What is hard or non-trivial? | Aider must keep model output under user and repo control: parse before writing, ask before expanding edit scope, protect dirty work, reflect malformed edits, and avoid committing unrelated dirty files. |
| What changes at each phase? | CLI state becomes session policy; a user message becomes provider messages; provider output becomes `partial_response_content`; parsed edits become authorized file writes; written files become optional commits and lint/test feedback. |
| Where would I change this behavior? | [`code-map.md`](../code-map.md) routes startup and session policy to `aider/`, edit gating to `aider/coders/`, and focused verification to `tests/basic/`. |
| Where do assumptions stop? | The guide does not trace GUI, watch mode, model registry internals, repo-map ranking, voice, browser, or architect/editor mode. It also does not claim provider behavior because tests stub `coder.send`. |
| What would prove this explanation wrong? | The focused edit tests would fail, especially successful diff application, dry-run no-write behavior, dirty target pre-commit, or excluding unrelated dirty files from Aider edit commits. |
| What would a careful newcomer ask next? | How model defaults choose an edit format, how repo-map context is ranked, and how architect mode delegates to editor coders. Those are deferred as separate walkthroughs. |
| How can I verify it? | Run the focused pytest commands in `references/source-evidence.md`, then run the repo-docs validator. |

## Review Table

| Review question | Result | Evidence | Follow-up |
| --- | --- | --- | --- |
| Can a reader state the hard part in one sentence? | Yes. The README and walkthrough both state that Aider treats model output as a proposal that must pass parse, permission, dirty-work, and verification gates. | [`README.md`](../README.md), [`walkthroughs/one-real-run.md`](../walkthroughs/one-real-run.md) | None for this scope. |
| Can the walkthrough explain the flow if source links are hidden? | Mostly yes. Each step begins with behavior and reason before source anchors. | [`walkthroughs/one-real-run.md`](../walkthroughs/one-real-run.md) | If the guide expands to model selection, add a second walkthrough rather than overloading this one. |
| Is there a real boundary or failure path? | Yes. Non-matching SEARCH blocks become reflected feedback; dry-run preserves files. | [`modules/edit-lifecycle.md`](../modules/edit-lifecycle.md), [`references/source-evidence.md`](source-evidence.md) | Add a dedicated failed-edit walkthrough only if future readers ask about reflection/debugging. |
| Are claims backed by current source or tests? | Yes for the scoped path. | [`references/source-evidence.md`](source-evidence.md) | Provider behavior remains intentionally unverified. |
| Does the evidence map show two passes and adjacent paths? | Yes. Pass 1 maps the path; Pass 2 records boundaries and tests; coverage notes list adjacent untraced surfaces. | [`references/source-evidence.md#evidence-traversal-log`](source-evidence.md#evidence-traversal-log), [`references/source-evidence.md#coverage-notes`](source-evidence.md#coverage-notes) | None. |
| What residual risk remains? | Line anchors may drift as source changes, and the guide only covers the default CLI edit lifecycle. | Current source inspection and scoped exclusions. | Future behavior-changing edits should update the smallest owning guide page and change log. |

Evidence status: Confirmed unless noted.
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: 472kUpdated 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: 198kUpdated 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: 198kUpdated 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: 198kUpdated Claude CodeCodexVerifiedInstall