Repository navigation
docs: add storage backend blueprint landing pages - #42
Merged
Merged
Conversation
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.
Triplex's site explains custom runtimes but has no backend-specific path from storage primitives to a working adapter. Add landing pages at
/sqlite,/foundationdb,/datomic, and/xtdb, plus a/backendsindex linked from the homepage, navigation, and custom runtime guide.Each blueprint maps storage, transactions, temporal reads, journal/receipts, and query execution to the Triplex contract, with a concrete correction scenario and implementation or conformance steps. SQLite is labeled supported, FoundationDB experimental/private, and Datomic and XTDB proposed with no existing adapters. The proposals explicitly cover the mismatch between Triplex's Effect transaction callback and native declarative/non-interactive writes. The homepage now describes current XTDB's SQL/XTQL model accurately.
Includes shared responsive styling, checked SQLite and FoundationDB examples, agent-readable Markdown exports through the existing documentation pipeline, and refreshed homepage visual snapshots.
Validation:
pnpm checkpassed (formatting, lint, typechecks, checked docs, default tests, package and docs builds).pnpm test:e2epassed: 13 tests, including the refreshed light/dark homepage snapshots.Documentation only; no storage adapters are added or promoted. FoundationDB's example is type-checked but native integration was not run.
Open workspace in Conductor