Docs describe things the code does not do: watermark-driven spill demotion, a throughput metric, a missing test file, CUDA never having run, PyO3 bindings

Open Beginner friendly
  • Is something wrong?
#132 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
rust
Domain
documentation

Research direction

Read the listed claims in docs/SPEC.md, docs/roadmap.md, docs/architecture.md, docs/verification.md, and the published description for oxidelake-api; compare them with STATUS and the current implementation. Check the existing tests under tests/ to decide what crates/oxidelake-storage/src/uring.rs should reference. Done means each claim matches the code and STATUS's matrix agrees with docs/verification.md.

Written by the indexing model from the issue text.

Description

documentation good first issue

Today — each verified against the code:

  1. docs/SPEC.md (~60), docs/roadmap.md (~30) and docs/architecture.md (~68) describe watermark-driven asynchronous demotion and a throughput metric for the spill manager; the code demotes inline as soon as the budget is exceeded and has no throughput counter (#25 already says the manager is library-only).
  2. crates/oxidelake-storage/src/uring.rs (~100) cites tests/uring_signals.rs, which does not exist (tests/ holds object_store_conformance.rs and pruning.rs).
  3. docs/verification.md (~111-129) still says "Two dev boxes so far", "never claim" CUDA execution and "no such box has run this yet", although STATUS records the 2026-09-06 T4 session.
  4. oxidelake-api's published description says "(PyO3 bindings optional)"; the python feature is deferred (STATUS).

Fix — make each sentence true; point uring.rs at the test that does exist (or add it).

Done when — each item is corrected and STATUS's matrix and verification.md agree.

Found in the 0.3.0 review; published 0.2.0 has the same code.

Dominant language
Rust
Stars
1
Forks
2
Avg merge
5d 22h
Merged PRs (30d)
4

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from vyncint/oxidelake

All issues in vyncint/oxidelake

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.