docs(depot): add high-level depot SQLite overview, consolidate docs#5224
Conversation
Add docs-internal/engine/depot-overview.md: a high-level map of the per-actor SQLite storage system (design constraints, glossary, UDB layout, VFS/depot-client/ depot path with inline vs remote envoy dispatch and fencing, deltas/PIDX/shards, read+write paths, compaction, GC + delta-retention algorithm, forking/pinning, and PITR). High level by design; links out to the sqlite/ reference docs. Delete the two explainer docs it supersedes (depot.md crash course, vfs-brief.md) and repoint the reference indexes in CLAUDE.md/README. Keeps storage-structure, components, constraints, and comparison docs as the detailed references. docs(depot): sync retention contract docs for watermark reclaim and fork alignment
Member
Author
|
Stack for rivet-dev/rivet
Get stack: |
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.
Add docs-internal/engine/depot-overview.md: a high-level map of the per-actor
SQLite storage system (design constraints, glossary, UDB layout, VFS/depot-client/
depot path with inline vs remote envoy dispatch and fencing, deltas/PIDX/shards,
read+write paths, compaction, GC + delta-retention algorithm, forking/pinning, and
PITR). High level by design; links out to the sqlite/ reference docs.
Delete the two explainer docs it supersedes (depot.md crash course, vfs-brief.md)
and repoint the reference indexes in CLAUDE.md/README. Keeps storage-structure,
components, constraints, and comparison docs as the detailed references.
docs(depot): sync retention contract docs for watermark reclaim and fork alignment