-
Notifications
You must be signed in to change notification settings - Fork 1
Open
Labels
area/infraCI, builds, tooling, project infrastructureCI, builds, tooling, project infrastructurecomplexity/averageStandard effort, moderate familiarity neededStandard effort, moderate familiarity neededdocumentationImprovements or additions to documentationImprovements or additions to documentationmilestone/v0.2.1priority/highHigh priority — closes a critical gapHigh priority — closes a critical gap
Description
Problem
contextweaver has no API reference documentation. Users must read source code to discover the API surface. This is a critical DX gap. The codebase already has comprehensive Google-style docstrings — the raw material exists, it just is not rendered.
Proposal
Add a documentation site using MkDocs + mkdocstrings that auto-generates API reference pages from existing docstrings.
- Add
mkdocs.ymlconfiguration with Material for MkDocs theme - Add
docs/reference/directory with per-module pages (types, config, protocols, envelope, context/manager, routing/catalog, routing/router, adapters/mcp, adapters/a2a, store modules) - Add
[project.optional-dependencies] docs = [...]extra inpyproject.toml - Add
make docstarget to build locally - Optionally add a GitHub Pages deployment workflow
Acceptance Criteria
-
mkdocs.ymlconfigured with mkdocstrings and Material theme - API reference pages generated for all public modules
-
pip install -e ".[docs]"installs documentation build tools -
make docsbuilds the docs site locally - Existing docs (architecture.md, concepts.md) integrated into the site
- README updated with link to docs site
File Paths
mkdocs.yml(new)docs/reference/(new)pyproject.toml(edit)Makefile(edit)
References
- mkdocstrings: https://mkdocstrings.github.io/
- Material for MkDocs: https://squidfunk.github.io/mkdocs-material/
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
area/infraCI, builds, tooling, project infrastructureCI, builds, tooling, project infrastructurecomplexity/averageStandard effort, moderate familiarity neededStandard effort, moderate familiarity neededdocumentationImprovements or additions to documentationImprovements or additions to documentationmilestone/v0.2.1priority/highHigh priority — closes a critical gapHigh priority — closes a critical gap