免费在 GitHub 公开

ccg-docs

code-context-graph — documentation generation, RAG indexing, and docs quality linting.

中文简介正在准备中。当前显示原文说明。

tae2089/code-context-graph星标 17(GitHub 17 + cccskills 0)

实测评分未实测

查看安装方法

包含的文件（1）

SKILL.md3.2 KB

SKILL.md（原文）

安装前可以查看交给 AI 代理的指令内容。

code-context-graph — Documentation & RAG Indexing

Generate Markdown documentation from code graphs, build RAG indexes for AI consumption, and lint documentation quality.

Subcommands

Command	Description	Example
`docs [--out dir]`	Generate Markdown documentation	`ccg docs --out docs`
`lint [--out dir]`	8-category docs lint	`ccg lint`
`lint --strict`	Exit 1 on issues (for CI/pre-commit)	`ccg lint --strict`
`hooks install`	Install pre-commit git hook	`ccg hooks install`
`hooks install --lint-strict`	Install hook that blocks commit on issues	`ccg hooks install --lint-strict`

MCP Tools (4)

Tool	Description
`build_rag_index`	Build RAG index from docs and communities. Use `namespace` for namespace-specific docs; `workspace` remains a deprecated alias.
`get_rag_tree`	Navigate RAG document tree. Use `namespace` for namespace-specific doc-index.json; `workspace` remains a deprecated alias.
`get_doc_content`	Get documentation file content. Use `namespace` for namespace-scoped docs; `workspace` remains a deprecated alias.
`search_docs`	Search RAG document tree by keyword. Use `namespace` for namespace-specific searches; `workspace` remains a deprecated alias.

Lint Categories (8)

Category	Description
orphan	Doc files with no matching source code
missing	Source files with no documentation
stale	Docs outdated vs source (hash/timestamp mismatch)
unannotated	Functions lacking @intent/@domainRule annotations
contradiction	Doc content contradicting code signatures
dead-ref	@see tags pointing to non-existent functions
incomplete	Partial documentation (missing @param, @return)
drift	Doc structure diverged from code structure

Usage Examples

Generate documentation

User: "문서 생성해줘"
→ ccg docs --out docs
→ Generates Markdown files for all modules

Build RAG index for AI

User: "RAG 인덱스 만들어줘"
→ build_rag_index via MCP
→ Creates searchable document tree from docs + communities

Check documentation quality

User: "문서 상태 체크해줘"
→ ccg lint
→ Returns 8-category report: orphan, missing, stale, unannotated, etc.

CI integration

# .github/workflows/docs.yml
- run: ccg lint --strict  # Fails build on documentation issues

Lint Rules & Regex Patterns

.ccg.yaml rules support regex patterns for pattern field. Patterns containing $, ^, +, {}, |, \., or .* are auto-detected as regex:

rules:
  # Exact match (legacy)
  - pattern: "pkg/auth.go::Login"
    category: unannotated
    action: ignore

  # Regex: ignore all symbols under pkg/store/
  - pattern: "pkg/store/.*"
    category: unannotated
    action: ignore

  # Regex: ignore all generated code
  - pattern: ".*_generated\\.go::.*"
    category: incomplete
    action: warn

Prerequisites

Graph must be built first. If it is missing or stale, report the gap; do not invoke /ccg-build unless the user explicitly names it. /ccg is read-only.

评价

还没有评价。欢迎分享你的使用感受。

无需登录即可发表。欢迎分享使用感受、提问，或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

同一仓库的技能

ccg

免费

Fast read-only code discovery with a bounded code-context-graph search and targeted source verification. Use when an ordinary positive lookup or explanation needs an entry point, recorded intent, known-path inventory, or direct relationship evidence. Do not use for absence, completeness, exhaustive inventory, deep flow or impact analysis, or graph writes; use ccg-search-verify for defensible negative claims, and require explicit invocation for ccg-analyze or ccg-build.

中文简介正在准备中。当前显示原文说明。