Hello Gophers! I’m designing DocuDex, a CLI that builds API reference for every dependency in a go.mod from the module cache (via go/doc), stores it locally, and serves it in a browser or to a coding agent — fully offline. It’s a solo side project, pre-code; the design doc, two ADRs, a POC write-up with benchmarks and architecture diagrams are here:
Two decisions I’d like challenged:
- Storage: Markdown files on disk as the source of truth, plus a SQLite FTS5 index.
- Manifest: a
docudex.tomlderived fromgo.modas DocuDex’s source of truth (it will warn about drift) rather than readinggo.moddirectly each run.
Replies welcome here or in the repo discussion: aureliushq/docudex · Discussions · GitHub. Feedback not limited to the above decisions are also welcome. I’ll close the review on Oct 24 and post what changed and what I held, with reasons.
Thank you!