thanos / rheo

89%

LAST BUILD ON BRANCH main

branch: SELECT

CHANGE BRANCH

x

• No branch selected
• main
• v0.1.0/MVP-mongodb
• v0.10.0/OPS_Functionality
• v0.11.0/Mnesia
• v0.11.1/review_fixes
• v0.12.0/cleanup-stablize_api
• v0.2.0/Architecture_Cleanup-Group_Runtime
• v0.4.0/Search-Replay-Event_Lineage
• v0.6.0/Ecto_Backend-PostgreSQL_and_SQLite
• v0.7.0/GenStage-Broadway_Interoperability
• v0.7.1/document_update
• v0.8.0/Architectural_Reset
• v0.9.0/Redis_Streams

Build # 6d318335b39df4b8570f9088d3d515db8c56e277

Build Type

push

github

Committed by thanos

Commit Message

Documentation pass is in place across the frozen public surface. Summary:

- **Value structs** (`Page`, `Lag`, `DeadLetter`, `GroupInfo`): field tables, `@typedoc`, examples
- **Facade** (`Rheo`): Arguments/Returns/Examples for ops APIs; ASCII supervision tree; crypto-unique doctest stream names
- **Consume**: `GroupSupervisor` (was stub), `Consumer` callbacks, `Group` drain, `Producer` ASCII + `config/0` doctest
- **Backend**: behaviour ASCII + callback error vocabulary + implementer sketch; ETS/Mnesia brought up to Mongo/Redis quality; Wakeup doctests registered
- **Runtime**: Id, Backoff, Inflight/Settle/Query typedocs, Telemetry.Metrics wiring example

- Re-enabled HexDocs ADR + migration extras in `mix.exs` (they had been commented out while `groups_for_extras` still listed them)
- ADR 015 links → GitHub (HexDocs 015 was 404)

`test/rheo/doctest_test.exs` expanded; **108 doctests passing**

- Prefer `path: ..` from a clone; Hex `~> 1.0` commented as alternate
- Index/ops framing updated for 1.0
- ETS smoke of the quickstart path OK (full Livebook UI not executed here)

- Mix inspect tasks and LiveDashboard `PageBuilder` callbacks (ops, not SemVer-core)
- `Group.drain/2` examples are non-iex (needs a live Group)
- Consumer callback examples stay in `@moduledoc` (not `iex>` doctests)

 - closed #163

Coverage Stats

3304 of 3709 relevant lines covered (89.08%)

1115.63 hits per line