Skip to content

docs(vindex): add subcomponent design documentation - #172

Merged
mhutchinson merged 3 commits into
transparency-dev:mainfrom
mhutchinson:vindex/pr-02-docs
Nov 2, 2026
Merged

mhutchinson merged 3 commits into
transparency-dev:mainfrom
mhutchinson:vindex/pr-02-docs

Conversation

@mhutchinson

@mhutchinson mhutchinson commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Part 2b in the vindex v1 upstreaming stack (rebased onto main following #177).

  • Adds the 9 subcomponent design documents (README.md across client/, mapfn/, and internal/{ingest,kvstore,tree,server,coordinator,auditor,hammer}/).
  • Adds links to those subcomponent designs in vindex/README.md (§6) and vindex/docs/ARCHITECTURE.md (§1.2).

PR Stack Roadmap

  1. docs(vindex): retire legacy MVP and add C2SP tlog-vindex specification (docs(vindex): retire legacy MVP and add C2SP tlog-vindex specification #171)
  2. 2a: docs(vindex): update tlog-vindex spec and add applications and architecture docs (docs(vindex): update tlog-vindex spec and add applications and architecture docs #177)
    2b: docs(vindex): add subcomponent design documentation (this PR)
  3. feat(vindex): add wire codecs and metrics leaf packages
  4. feat(vindex/mapfn): add WASM guest SDK, wazero sandbox host, examples, and CLI
  5. feat(vindex/ingest): add tile-cached ingestion pipeline
  6. feat(vindex/kvstore): add Pebble inverted chunk storage engine
  7. feat(vindex/tree): add variable-length MPT state trie and output log publisher
  8. feat(vindex): add sync coordinator and C2SP HTTP read server
  9. feat(vindex/client): add verifiable C2SP client SDK and top-level Engine API
  10. feat(vindex/auditor): add independent full-log auditor
  11. feat(vindex/hammer): add continuous load-testing and verification hammer
  12. feat(vindex/cmd): add vindexd daemon, client CLI, dashboards, and e2e suite
  13. feat(vindex/sumdb): add Go SumDB index/verify binaries, Docker stack, and quickstart
  14. feat(vindex/mtc): add MTC and Static-CT personalities, clonelog, and auditor CLI

@mhutchinson mhutchinson changed the title docs(vindex): add system architecture, prefix lookup design, and benchmarks docs(vindex): add system architecture, prefix lookup, and subsystem designs Oct 22, 2026
@mhutchinson
mhutchinson force-pushed the vindex/pr-02-docs branch 3 times, most recently from fcdef0c to fc824b3 Compare October 22, 2026 15:17
@mhutchinson mhutchinson changed the title docs(vindex): add system architecture, prefix lookup, and subsystem designs docs(vindex): add system architecture and subsystem designs Oct 22, 2026
@mhutchinson mhutchinson changed the title docs(vindex): add system architecture and subsystem designs docs(vindex): add subcomponent design documentation Oct 27, 2026
@mhutchinson
mhutchinson force-pushed the vindex/pr-02-docs branch 6 times, most recently from 19656b3 to 0b2f864 Compare October 29, 2026 15:13
- Add subcomponent design READMEs across client/, mapfn/, and internal/{ingest,kvstore,tree,server,coordinator,auditor,hammer}/.
- Link subcomponent design docs from vindex/README.md and vindex/docs/ARCHITECTURE.md.
@mhutchinson
mhutchinson force-pushed the vindex/pr-02-docs branch 3 times, most recently from 29a3d11 to 0e42aec Compare November 2, 2026 11:39
@mhutchinson
mhutchinson merged commit cdad796 into transparency-dev:main Nov 2, 2026
13 checks passed
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.

2 participants