Skip to content

v6: docs — MkDocs Material on Read the Docs, generated reference, CI-tested snippets #48

Description

@Pandys

Current RTD "latest" still documents the 4.x HTTP interface and is a default Sphinx/Alabaster autodoc dump. Same fix as the code: generate the reference, hand-write only a few small guides.

  • MkDocs + Material + mkdocstrings; keep the clappform.readthedocs.io domain (RTD supports MkDocs); per-release version selector (staggered clusters -> users must read docs for THEIR version); 4.x docs stay archived under their tag
  • Reference generated from the wrapper layer's docstrings (which come from proto comments) — a new RPC appears in docs in the same PR that adds it to the client
  • Hand-written: quickstart (install/connect/DataFrame round-trip in ~20 lines); how-tos: DataFrame flows, multi-cluster/multi-tenant, error handling & retries, testing with LocalMock; changelog from releases incl. proto diffs
  • Every guide snippet runs against LocalMock in CI (snippet-include from examples/) — a broken doc example fails the build

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationpriority: mediumNeeded for release, not blocking corev6v6 rewrite (Major/6)

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions