Overhaul documentation in different submodules #3

arindas · 2022-12-23T16:18:33Z

Added missing documentation for different items under crate::server
Added diagrams to explain the execution model and the segmented log data structure
Make Testing much more accessible with proper description in README

…ied offset for new record in README.

arindas added 19 commits December 20, 2022 14:23

Improved README and lib.rs docs.

5c711f0

Fixed links in documentation.

e4e01bd

Added documentation for server::{single_node, worker, tokio_compat}

da8fabc

Updated README with diagram for segmented log.

b871d4d

Corrected coninuation dashes in segmented log diagram.

4494c06

Centered labels in segmented-log diagram.

9d8a342

Centered labels in segmented-log diagram.

ff7c69e

Clarified position and offset calculations further. Explicitly specif…

a987920

…ied offset for new record in README.

Maded the testing section in the README more accessible.

e6902e7

Clarified state of testing on WSL

5274edc

Added missing documentation for different modules.

8674aa8

Corrected doc links.

3fea11f

Added documentation for items under common/

ab42b4e

Added documentation for record metadata in segmented_log.

995bc2c

Made lib.rs design section consistent with README.

34a4beb

Improved documentation for partition::single_node::commit_log::Partition

d959fd7

Removed trailing spaces in docs.

e7b7854

Added missing docs for PartitionId and PartitionRequest.

4282d06

Corrected typos and added missing documentation where necessary.

09d11ff

arindas merged commit 6915da8 into feature/server Dec 23, 2022

arindas deleted the enhancement/readme-lib-rs-docs branch December 23, 2022 19:16

Provide feedback