Skip to content

docs: add architecture overview#35

Open
tripledoublev wants to merge 1 commit into
mainfrom
docs/architecture
Open

docs: add architecture overview#35
tripledoublev wants to merge 1 commit into
mainfrom
docs/architecture

Conversation

@tripledoublev

@tripledoublev tripledoublev commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

What

Adds docs/ARCHITECTURE.md — a concise architecture overview of the Save DWeb Rust stack, as an orientation point for a new maintainer.

Covers:

  • The stack — the tag-pinned chain veilid → veilid-iroh-blobs → save-dweb-backend → save-rust → apps, and the sibling-checkout layout.
  • save-dweb-backend (the engine) — the Group / Repo / Member / DHT / tunnel model and a module map (defers wire-level detail to its own README).
  • save-rust (the bridge) — the JNI + actix-web HTTP wrapper, module map, build outputs (libsave.so / xcframework), and where the Android artifact lands.
  • veilid-iroh-blobs — its role as the Veilid↔iroh-blobs tunnel layer.
  • Build & run, CI/CD, testing & flakiness, releases & versioning, access/accounts, and open questions/risks.

Veilid upgrades are out of scope here — they live in the .claude/skills/veilid-upgrade/ runbook, which this doc links to.

Also adds discoverability pointers from README.md, CLAUDE.md, and AGENTS.md.

Notes

  • Documentation only — no code changes.
  • CI/CD facts verified against the live workflows: save-rust runs a 3-test smoke subset on PRs and pushes to main; save-dweb-backend runs the full suite on PRs only.

🤖 Generated with Claude Code

Comment thread docs/ARCHITECTURE.md Outdated
Comment thread docs/ARCHITECTURE.md Outdated
@tripledoublev tripledoublev changed the title docs: architecture overview & maintainer handoff docs: add architecture overview Jun 30, 2026
Add docs/ARCHITECTURE.md, a concise architecture overview of the Save DWeb
Rust stack (save-rust + save-dweb-backend + veilid-iroh-blobs): the tag-pinned
dependency chain, the engine's group/repo/member/DHT model, the save-rust
JNI + HTTP bridge, build/run, CI/CD, the P2P test flakiness model, releases,
and access map. Veilid upgrades are out of scope and link to the
veilid-upgrade skill.

Also add discoverability pointers from README, CLAUDE.md, and AGENTS.md.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant