Repository navigation
docs(readme): where to run it, and which disks are tested - #76
Merged
Merged
Conversation
Signed-off-by: Shreyansh Sancheti <43677304+shreyanshjain7174@users.noreply.github.com>
There was a problem hiding this comment.
🟢 Approval recommended
The documentation-only changes match the recorded benchmarks and existing operating requirements, with no unresolved findings.
No open issues 🎉
What changed in this PR
Adds deployment and storage guidance ahead of Quick start, covering the documentation portion of #71 without changing runtime behavior.
Changes:
- Clarifies macOS/Linux support and the current build-from-source requirement.
- Lists tested storage and measured sync latencies, warns against unsuitable filesystems, and documents data-directory permissions and low-space behavior.
| File | Description |
|---|---|
| README.md | Adds supported-platform, storage, and data-directory guidance. |
Review effort: Balanced
1 of 7 tasks
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.
Adds a short README section, ahead of Quick start, covering supported platforms and where to keep the data directory. Part of #71 (P1). Docs only.
bench/RESULTS.md: about 60 µs on NVMe, 1.9 ms on Premium SSD v2, 4.4 ms on P30.Every number comes from
bench/RESULTS.md(the zero-filled spares section). Nothing is claimed for disks we haven't run.