Repository navigation

docs: make the docs.rs reference usable - #149

Merged

olavgg merged 8 commits into

chore/remove-dead-codefrom

docs/usable-api-reference

Sep 30, 2026

Merged

docs: make the docs.rs reference usable#149
olavgg merged 8 commits into
chore/remove-dead-codefrom
docs/usable-api-reference

Commits on Sep 24, 2026
- docs: give the crate a landing page and build docs.rs the way the README reads
  
  JosteinGj
  and
  claude
  committed
  617fcb8
- docs: document ApiService and create_api_service
  
  JosteinGj
  and
  claude
  committed
  88243b5
- docs: describe every module, and hide the plumbing from the reference
  
  JosteinGj
  and
  claude
  committed
  91629d3
- docs: describe every public type
  
  JosteinGj
  and
  claude
  committed
  3e6d36f
- docs: document the remaining service methods
  
  JosteinGj
  and
  claude
  committed
  167aa4d
- ci: fail the build when the docs break
  
  JosteinGj
  and
  claude
  committed
  7522e16
- docs: build the reference on stable, and say in the blocking module doc that it needs the feature
  
  JosteinGj
  and
  claude
  committed
  5fdbb71
Commits on Sep 25, 2026
- ci: run the doctests in the crate job instead of a separate docs job
  
  JosteinGj
  and
  claude
  committed
  f0271fc