From 8a9e71be9600c7399c650318854097f9d75a7049 Mon Sep 17 00:00:00 2001 From: forhappy Date: Mon, 17 Aug 2026 21:00:03 -0700 Subject: [PATCH] docs: link Prolly repository references --- API.md | 4 ++++ CACHE-AND-SCALE-DESIGN.md | 3 ++- CHANGELOG.md | 3 ++- CONTRIBUTING.md | 3 ++- README.md | 4 ++++ SILO-DESIGN.md | 3 ++- client/README.md | 4 ++-- core/README.md | 3 ++- 8 files changed, 20 insertions(+), 7 deletions(-) diff --git a/API.md b/API.md index c4f52f3..95f1623 100644 --- a/API.md +++ b/API.md @@ -8,6 +8,10 @@ Goal: choose the right client method, understand the snapshot and consistency ru The client adapter uses the AWS SDK for Rust. The same adapter talks to Amazon S3 and compatible services that pass SILO’s provider qualification probes. The repository format, upgrade rules, cache contract, and production support posture are defined in [`GA-CONTRACT.md`](GA-CONTRACT.md). +SILO uses [Prolly trees](https://github.com/crabbuild/prolly) for +content-addressed metadata and history. This guide focuses on the S3-backed +repository API around those trees. + ## Choose an API by task Use this table to find the shortest path to a common operation: diff --git a/CACHE-AND-SCALE-DESIGN.md b/CACHE-AND-SCALE-DESIGN.md index 70b0a1e..f6e9b14 100644 --- a/CACHE-AND-SCALE-DESIGN.md +++ b/CACHE-AND-SCALE-DESIGN.md @@ -45,7 +45,8 @@ branch ref → immutable payload ``` -The journal-derived index is a Prolly tree of content ID to node-pack range. +The journal-derived index is a [Prolly tree](https://github.com/crabbuild/prolly) +of content ID to node-pack range. Its small mutable head advances behind the publication journal. Normal point lookups never list the repository namespace. diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a7bead..af838ec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,7 +4,8 @@ All notable SILO changes will be recorded here. ## Unreleased -- Extracted the immutable S3 version-control ledger from the Prolly monorepo. +- Extracted the immutable S3 version-control ledger from the [Prolly + monorepo](https://github.com/crabbuild/prolly). - Added standalone SILO workspace metadata, open-source CI, RustFS qualification, security policy, and release scaffolding. - Preserved the `prolly-s3` durable protocol namespace for existing buckets. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 91ba502..dc1beb1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,8 @@ # Contributing to SILO SILO is an open-source CrabBuild repository. Contributions are reviewed -through pull requests and must preserve the durable repository contract. +through pull requests and must preserve the durable repository contract. SILO +was extracted from the [Prolly repository](https://github.com/crabbuild/prolly). ## Before opening a pull request diff --git a/README.md b/README.md index b46b8b5..e2e1322 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ branches, tags, listings, diffs, merges, recovery checkpoints, and garbage collection while keeping user file bodies as complete immutable provider objects. +SILO uses [Prolly](https://github.com/crabbuild/prolly) trees for +content-addressed metadata, snapshots, and history. This repository adds the +S3-backed repository layer and provider workflows around those trees. + > **Repository status:** SILO is open source under the MIT License. The > repository is pre-1.0; tagged releases publish public GitHub release bundles, > while crates.io publication remains a separately controlled release step. diff --git a/SILO-DESIGN.md b/SILO-DESIGN.md index 439008b..b517bcc 100644 --- a/SILO-DESIGN.md +++ b/SILO-DESIGN.md @@ -4,7 +4,8 @@ SILO is a thin repository layer over a versioned S3 bucket. The client is the authoritative writer. It stores each file as one immutable payload and uses -Prolly trees to track names, metadata, commits, branches, and history. +[Prolly trees](https://github.com/crabbuild/prolly) to track names, metadata, +commits, branches, and history. There is one durable format and one public client. The implementation does not dual-write, migrate, or negotiate legacy repository protocols. diff --git a/client/README.md b/client/README.md index 0b2d247..dde9824 100644 --- a/client/README.md +++ b/client/README.md @@ -1,8 +1,8 @@ # SILO client The client turns a versioned S3 bucket into a branchable file repository. -Files remain ordinary whole S3 objects under immutable derived keys; Prolly -trees provide snapshots and history. +Files remain ordinary whole S3 objects under immutable derived keys; [Prolly +trees](https://github.com/crabbuild/prolly) provide snapshots and history. ## Requirements diff --git a/core/README.md b/core/README.md index 6c33844..b926c32 100644 --- a/core/README.md +++ b/core/README.md @@ -3,7 +3,8 @@ The AWS-independent core of [SILO](https://github.com/crabuild/silo), an immutable version-control ledger layered over S3-compatible object storage. -This crate owns the durable repository model, Prolly-tree state, commits, +This crate owns the durable repository model and [Prolly tree +state](https://github.com/crabbuild/prolly), commits, branches, tags, journals, recovery, fsck, merge planning, and garbage collection. The provider adapter lives in `silo-s3-client`.