Update README and crate documentations #107

jkosh44 · 2025-12-20T20:49:46Z

This commit makes the following documentation changes:

Add missing metrics to README.md.
Remove non-existent metrics from README.md.
Re-order metrics in README.md and Rust code so that the order matches between the two. This makes the docs easier to maintain and read.
Add missing links to README.md.
Split runtime metrics into stable and unstable subsections in README.md.
Remove duplicate stable runtime base metrics section from README.md.
Add metrics.rs task metrics integration docs to README.md.
Add metrics.rs task metrics integration docs to crate docs in lib.rs.

This commit makes the following documentation changes: - Add missing metrics to README.md. - Remove non-existent metrics from README.md. - Re-order metrics in README.md and Rust code so that the order matches between the two. This makes the docs easier to maintain and read. - Add missing links to README.md. - Split runtime metrics into stable and unstable subsections in README.md. - Remove duplicate stable runtime base metrics section from README.md. - Add metrics.rs task metrics integration docs to README.md. - Add metrics.rs task metrics integration docs to crate docs in lib.rs.

README.md

src/task.rs

README.md

jkosh44 · 2026-01-08T23:42:06Z

@arielb1 FYI, no rush, just wanted to make sure this didn't fall through the cracks since I opened it during the holidays.

jlizen

Thanks for the ping - and thank you for the cleanup!!

Let me know if you do want to take another pass based on my comments. I'm also happy to merge it as-is, just give me the go-ahead :)

README.md

src/lib.rs

jkosh44 · 2026-01-09T00:35:50Z

Let me know if you do want to take another pass based on my comments.

I'll take another pass, thanks for the review!

jlizen · 2026-01-09T03:06:09Z

Thanks for the contribution ♥️
Will get it rolled out as part of #53