feat: index Markdown files

未关闭
#115 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
18/100
Issue 类型
功能
描述清晰度
需要澄清
活跃度
活跃
技术栈
go, markdown
领域
tooling

调研方向

Start with internal/indexer/discover_test.go at lines 206 and 235, which assert that README.md is never discovered, and with the language entries in internal/indexer/languages_<lang>.go. The first decision is what a Markdown symbol is (headings, links, code fences) and whether it fits the graph vocabulary; this needs maintainer input before any code. Done means a recorded vocabulary decision, a discover test changed with a stated reason, and an updated capability matrix.

由索引模型根据 Issue 内容生成。

描述

area:indexer feature priority:low spec-needed
What problem does this solve?

Documentation in Markdown (READMEs, ADRs, runbooks) is invisible to explore, search and the MCP tools, so an agent cannot reach docs through the graph.

What should it do?

To be decided first: what a Markdown "symbol" is (headings, links, code fences) and whether it belongs in the same graph vocabulary as functions and types. Then add a language entry following internal/indexer/languages_<lang>.go.

Which surface does this affect?

Indexing / extraction

Is this covered by an existing command or tool today?

No. .md is excluded by assertion, not by omission: internal/indexer/discover_test.go:206,235 asserts README.md is never discovered, so this change must narrow or replace that test deliberately. No tree-sitter-markdown grammar is vendored (go.mod). The upstream grammar is split into block and inline parsers, which does not fit the one-grammar-per-language registry. A new CGo dependency also enters the SBOM and the govulncheck set.

Acceptance criteria
  • A recorded vocabulary decision.
  • The discover test changed with a stated reason.
  • The capability matrix updated.

Source (GSD planning files, archived at d384473e): .planning/seeds/SEED-003-markdown-in-the-index.md


🤖 Generated with Claude Code

https://claude.ai/code/session_01UNqdnC3q6U362BvyfxuKCF

主要语言
Go
星标
0
派生
0
平均合并
7 小时 42 分钟
30 天内合并 PR
111

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

seanb4t/codegraph-go 的其他 Issue

查看 seanb4t/codegraph-go 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。