docs(core): expand package guide - #9
Merged
Merged
Conversation
forhappy
marked this pull request as ready for review
August 18, 2026 06:00
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
1 participant
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.
Summary
core/README.mdinto a complete guide forsilo-s3-core0.1.0.ObjectPlanecontract, repository model, durable namespace, metadata/data lanes, bulk commit sessions, snapshots, history, diffs, merges, recovery, fsck, repair, transfer, GC, caching, errors, compatibility, and scaling guidance.Why
The core package previously had only a short description. Users implementing a provider adapter or evaluating the Prolly metadata layer need a package-local explanation of the durable invariants and the operational boundaries.
Validation
git diff --checkcargo fmt --all -- --checkcargo package --locked -p silo-s3-core --allow-dirtycargo metadata --locked --format-version 1 --no-deps