feat: native code documentation engine (auto-generated API docs) #131

Open
opened 2026-05-21 17:27:33 +00:00 by jmiller · 0 comments
Owner

Summary

Build a native code documentation engine that auto-generates browsable API docs from source code comments across all repos.

Priority: High

Core

  • Parse standard doc comments (Go godoc, JSDoc, PHPDoc, Python docstrings)
  • Auto-map functions, types, interfaces and relationships
  • Generate browsable HTML at /{owner}/{repo}/docs
  • Update on push to default branch
  • Cross-language: Go, TypeScript, PHP, Python

Features

  • Function/method index with search
  • Type hierarchy visualization
  • Cross-reference links
  • Source code click-through to file:line
  • Per-org documentation index
  • Doc coverage badge
  • Support MokoStandards FILE INFORMATION blocks

Implementation

  • Background job (like repo indexing)
  • Store parsed data in database
  • Integrate with bleve search
  • Consider tree-sitter for parsing

Authored-by: Claude Opus 4.6 (1M context)

## Summary Build a native code documentation engine that auto-generates browsable API docs from source code comments across all repos. ## Priority: High ### Core - Parse standard doc comments (Go godoc, JSDoc, PHPDoc, Python docstrings) - Auto-map functions, types, interfaces and relationships - Generate browsable HTML at /{owner}/{repo}/docs - Update on push to default branch - Cross-language: Go, TypeScript, PHP, Python ### Features - Function/method index with search - Type hierarchy visualization - Cross-reference links - Source code click-through to file:line - Per-org documentation index - Doc coverage badge - Support MokoStandards FILE INFORMATION blocks ### Implementation - Background job (like repo indexing) - Store parsed data in database - Integrate with bleve search - Consider tree-sitter for parsing *Authored-by: Claude Opus 4.6 (1M context)*
jmiller added the pending: design label 2026-05-22 02:01:08 +00:00
Sign in to join this conversation.
No labels pending: design
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: MokoConsulting/MokoGitea#131