lance-format / lance-format/lance
Document compaction algorithm
Open
Nobody has claimed this yet.
A-docs
documentation
- Dominant language
- Rust
- Stars
- 7.1k
- Forks
- 852
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 272
Description
We should document the algorithm that compaction uses. If I recall correctly there are certain rules (e.g. only compact neighbors, don't compact fragments if the index coverage is unequal) and it would be good to have these written down for easy access.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the compaction implementation to verify the rules described in the issue, including neighbor-only compaction and unequal index-coverage cases. Document the confirmed algorithm and its constraints in the project's appropriate documentation location; done means the behavior and exceptions are easy to find and understand.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100