Saturday, October 17, 2026
HomeGolangRFC: DocuDex, an offline documentation CLI for Go initiatives - Code Evaluation

RFC: DocuDex, an offline documentation CLI for Go initiatives – Code Evaluation


Hey Gophers! I’m designing DocuDex, a CLI that builds API reference for each dependency in a go.mod from the module cache (through go/doc), shops it regionally, and serves it in a browser or to a coding agent — totally offline. It’s a solo aspect venture, pre-code; the design doc, two ADRs, a POC write-up with benchmarks and structure diagrams are right here:

Two selections I’d like challenged:

  1. Storage: Markdown recordsdata on disk because the supply of reality, plus a SQLite FTS5 index.
  2. Manifest: a docudex.toml derived from go.mod as DocuDex’s supply of reality (it’ll warn about drift) somewhat than studying go.mod instantly every run.

Replies welcome right here or within the repo dialogue: aureliushq/docudex · Discussions · GitHub. Suggestions not restricted to the above selections are additionally welcome. I’ll shut the evaluate on Oct 24 and put up what modified and what I held, with causes.

Thanks!

RELATED ARTICLES

LEAVE A REPLY

Please enter your comment!
Please enter your name here

Most Popular

Recent Comments