18336875976
88%
main: 88%

Ran 08 Oct 2025 07:20AM UTC

Jobs 1

Files 197

Run time 1min

Badge

Embed ▾

Committed 08 Oct 2025 03:49AM UTC coverage: 91.079% (+0.02%) from 91.063%

Build # 18336875976

Build Type

push

github

Committed by

drmingdrmer

Commit Message

docs: comprehensive documentation improvements across codebase

Enhanced documentation with 30+ improvements across multiple areas:

**Architecture Documentation:**
- Add engine-runtime.md explaining Engine/Runtime separation (93 lines)
- Improve state-machine.md, replication.md, cluster-control.md
- Add structure to log_replication.md with clear section headers

**Module Documentation (14+ modules):**
- core, membership, vote, entry, log_id, config
- impls, testing, base, node, storage, network
- Add module-level docs with key types, overviews, and usage examples

**Example READMEs (7+ examples):**
- rocksstore, raft-kv-memstore-grpc, singlethreaded
- opendal-snapshot, network-v2, utils, mem-log
- Add feature highlights, comparison tables, architecture sections

**API Documentation:**
- Feature flags documentation in lib_readme.md
- Cross-references in core traits (RaftStateMachine, RaftLogStorage, RaftNetworkFactory)
- Enhanced RaftNetwork trait method documentation

**Project Documentation:**
- Add refinements/refinement-documentation.md for tracking improvements
- Add scripts/check.sh for basic validation
- Add measure_error_size.rs test for optimization tracking

All changes follow consistent documentation template with clear structure,
practical examples, and cross-references to related documentation.

Run Details

11374 of 12488 relevant lines covered (91.08%)

103415.34 hits per line

Uncovered Existing Lines

Lines	Coverage	∆	File
1	82.09	0.0%	openraft/src/metrics/serde_instant.rs
3	94.37	8.45%	openraft/src/core/heartbeat/worker.rs
4	90.7	-9.3%	openraft/src/progress/entry/update.rs

Jobs

ID	Job ID	Ran	Files	Coverage
1	18336875976.1	08 Oct 2025 07:20AM UTC	197	91.08	GitHub Action Run

databendlabs / openraft / 18336875976
88%
main: 88%

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 18336875976

databendlabs / openraft / 18336875976 88% main: 88%

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Uncovered Existing Lines

Jobs

Source Files on build 18336875976

databendlabs / openraft / 18336875976
88%
main: 88%

README BADGES
x