-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
cross-repoAffects multiple repos in the edictum-ai orgAffects multiple repos in the edictum-ai org
Description
Affected repos
edictum(Python) — needs pdoc or mkdocstringsedictum-ts(TypeScript) — needs TypeDocedictum-go(Go) — needs v0.1.0 tag for pkg.go.dev auto-indexing
Context
Every public class, method, and parameter should have browsable reference docs. For a security product, users need to verify exact method signatures and parameter semantics without reading source.
Current state
- Python: No doc generation. 44-58% docstring coverage — improve coverage first, then generate.
- TypeScript: No TypeDoc. 7 packages, ~80+ exports from core. TSDoc comments present.
- Go: Module not published.
go.moddeclares Go 1.25 (unreleased) — may block pkg.go.dev indexing until 1.25 ships or version is lowered.
Plan
- Python: Improve docstring coverage to 80%+ on public API, then add pdoc to dev deps + generation script
- TypeScript: Add typedoc + config for
@edictum/core(expand to adapters later) - Go: Tag v0.1.0 release once Go 1.25 blocker is resolved — pkg.go.dev auto-generates
Priority
P2 — valuable for credibility but not blocking anyone today. Do before public launch of TS/Go.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
cross-repoAffects multiple repos in the edictum-ai orgAffects multiple repos in the edictum-ai org