Site: consensus/Raft docs section + SEO refresh#13
Open
uptonm wants to merge 2 commits into
Open
Conversation
Phase-1 consensus (log store, transport, RaftCore) is merged to main but wasn't reflected on the site. Add content/docs/consensus/ (index, log store, transport, election-and-replication, read-index, safety invariants & simulation) covering what's actually built: pre-vote election, log replication with the consistency check, current-term commit rule, and read-index linearizable reads, proven by a deterministic fault-injecting simulation against four safety invariants. Also: add a pre-vote-and-read-index ADR documenting the pre_vote:bool RPC-contract fix a whole-branch review caught before merge, update roadmap.mdx to mark Phase 2 core as shipped with an honest next-up list (snapshots/membership, node driver, chaos harness), and update architecture.mdx/index.mdx so the top-level story includes the consensus layer without overstating what's wired together yet. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Root metadata, per-page metadata (createPageMetadata), sitemap.ts, and robots.ts were already built out (title template, OG/Twitter cards via public/og.png, canonical URLs, JSON-LD SoftwareApplication schema, sitemap enumerating source.getPages() so new docs pages can't drift out of it). Audited that infrastructure and found it sound — no structural gaps to fix. Refresh siteConfig's description and keywords so they cover the consensus work now documented on the site: add "distributed key-value store", "linearizable reads"/"linearizability", and "LSM storage engine" alongside the existing Raft/Rust/MVCC/sharding terms, and mention linearizable reads explicitly in the root description. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
Side-mission: bring the docs site up to date with the now-built consensus layer, plus a targeted SEO pass. Content + metadata only — no visual redesign (that's the designer's), and no deploy.
Docs content
content/docs/consensus/section (mirrors the depth/structure oflsm-engine/): index, log-store, transport, election-and-replication, read-index, and safety-and-simulation (the headline "provable correctness under failure" page — the four invariants + the deterministic fault-injecting sim).decisions/pre-vote-and-read-index.mdx— why pre-vote + read-index, and the realpre_vote: boolRPC-contract bug the whole-branch review caught (accurate to what happened).roadmap.mdx,architecture.mdx,index.mdxto reflect: Phase-1 consensus core shipped; snapshots/membership → node driver/TCP → chaos harness next. Claims kept honest — MVCC/sharding still "planned", node-driver/TCP/chaos "not yet built".SEO
The site already had a solid SEO layer (title template, per-page
generateMetadata, OG/Twitter cards →public/og.png, canonical URLs,sitemap.tsderiving fromsource.getPages(),robots.ts, JSON-LD). Targeted change: refreshedsite-config.tsdescription/keywords to cover "distributed key-value store", "linearizable reads", "LSM storage engine" alongside the existing terms. New docs pages are auto-picked-up by the sitemap.Verification
bun installclean;cd apps/site && bun run build→ ✓ Compiled successfully, 31 routes (21/docs/*, +7 new), sitemap/robots generated..ts/.json; the 1 pre-existing lint error (gates.ts) + 4 pre-existing!importantwarnings were untouched.Not deployed
Left unmerged intentionally — merging to
mainmay trigger a Vercel production deploy of cairn.uptonm.dev, which per the locked decision needs your explicit go. Review, then merge/deploy when you're ready.🤖 Generated with Claude Code