Repository navigation
Explain key parameters in README.md - #49
Merged
Merged
Conversation
Yi Shan (acmshanyi)
requested review from
Konstantin V Shvachko (shvachko)
and
a balanced review from Copilot
November 18, 2026 23:42
There was a problem hiding this comment.
🟢 Approval recommended
The README-only configuration documentation update has no active review issues.
No open issues 🎉
What changed in this PR
Adds configuration guidance to the README to help users tune Bf-Tree’s buffer, backing storage, and snapshot behavior. No runtime code changes are included.
Changes:
- Documents configuration setup, validation, parameter defaults, and constraints.
- Explains buffer promotion rates, storage backends, and cache-only mode.
- Clarifies snapshot settings and explicit snapshot creation.
| File | Description |
|---|---|
| README.md | Adds configuration tables and guidance for buffer management, storage, and snapshots. |
Review effort: Balanced
Yi Shan (acmshanyi)
force-pushed
the
shayi/configs
branch
from
November 19, 2026 00:48
35cc3a9 to
5e24b43
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add explanations of key config parameters in README.md