Skip to content

Set up generated API reference for all 3 language implementations #2

@acartag7

Description

@acartag7

Affected repos

  • edictum (Python) — needs pdoc or mkdocstrings
  • edictum-ts (TypeScript) — needs TypeDoc
  • edictum-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.mod declares Go 1.25 (unreleased) — may block pkg.go.dev indexing until 1.25 ships or version is lowered.

Plan

  1. Python: Improve docstring coverage to 80%+ on public API, then add pdoc to dev deps + generation script
  2. TypeScript: Add typedoc + config for @edictum/core (expand to adapters later)
  3. 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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    cross-repoAffects multiple repos in the edictum-ai org

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions