docs: improve docs and add diagrams - #82
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Docs-only refresh aligning repository documentation with the current (post-migration) ingot architecture, including a new as-built diagram set intended to stay in sync with the code.
Changes:
- Rewrites/updates core docs to reflect the current bucket-segregated catalog log, blob upload flow, and hilt-owned tenancy/auth.
- Adds
docs/diagrams.mdwith an indexed set of as-built diagrams (with per-diagram “Sources” footers and a package-to-diagram map). - Updates/clarifies a small number of in-code comments to match the current architecture.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| server.go | Updates the flush-function comment to describe the per-bucket catalog ship path. |
| registry/postgres.go | Updates type-level documentation to reflect hilt-owned bucket authority and local SQL-only bucket rows. |
| README.md | Refreshes high-level architecture overview and running instructions; adds pointers to architecture + diagrams docs. |
| module.go | Updates package/module doc comment to match the current body-vs-catalog split and seams. |
| logstore/README.md | Rewrites logstore docs to reflect the per-bucket catalog-only log and its lifecycle/diagrams. |
| docs/s3-versioning.md | Adds a cross-link to the relevant diagram for the version storage shape. |
| docs/diagrams.md | New as-built diagram set + index and maintenance mapping. |
| docs/architecture.md | Updates target-architecture doc references and refreshes schema appendix text to match current implementation. |
| DESIGN_NOTES.md | Rewrites “as-operated-today” description to match current runtime/auth/shipping behavior and known gaps. |
| CLAUDE.md | Updates repo working notes (package map, seams, config keys, testing, diagram maintenance rule). |
Suppressed comments (1)
logstore/README.md:193
ManagerConfigis not declared inconfig.go(it lives inmanager.go). Keeping it listed here makes the table inaccurate.
| `config.go` | `Config`, `ManagerConfig`, `PlaneConfig`, `FlushFunc` |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+269
to
273
| // newBucketFlushFunc builds the logstore flush callback for one bucket's | ||
| // log: it ships a sealed catalog CAR to Forge via uploader.SubmitShard, | ||
| // then records the shard's location and every inner block's byte range | ||
| // in the local location/inclusion tables (the appliance mirror of the | ||
| // sharded-dag-index SubmitShard publishes). The store owns the |
alanshaw
reviewed
Aug 21, 2026
alanshaw
approved these changes
Aug 21, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: ash <alan138@gmail.com>
alanshaw
force-pushed
the
frrist/docs/refresh-and-diagrams
branch
from
August 21, 2026 12:50
6581bd7 to
3289f57
Compare
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.
Docs-only refresh — the overdue post-migration doc pass, plus new as-built diagrams.
Manager), and CLAUDE.md (package map, config keys, seams, dependency list).module.go,registry/postgres.go,server.go; no behavior change anywhere in the diff.🤖 Generated with Claude Code