Skip to content

Explain key parameters in README.md - #49

Merged
Yi Shan (acmshanyi) merged 1 commit into
mainfrom
shayi/configs
Nov 19, 2026
Merged

Yi Shan (acmshanyi) merged 1 commit into
mainfrom
shayi/configs

Conversation

@acmshanyi

Copy link
Copy Markdown
Contributor

Add explanations of key config parameters in README.md

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

@acmshanyi
Yi Shan (acmshanyi) merged commit 6c67d40 into main Nov 19, 2026
6 checks passed
@acmshanyi
Yi Shan (acmshanyi) deleted the shayi/configs branch November 19, 2026 01:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants