Skip to content

docs: improve docs and add diagrams - #82

Merged
alanshaw merged 2 commits into
mainfrom
frrist/docs/refresh-and-diagrams
Aug 21, 2026
Merged

docs: improve docs and add diagrams#82
alanshaw merged 2 commits into
mainfrom
frrist/docs/refresh-and-diagrams

Conversation

@frrist

@frrist frrist commented Aug 14, 2026

Copy link
Copy Markdown
Member

Docs-only refresh — the overdue post-migration doc pass, plus new as-built diagrams.

  • Rewrites the four documents that still described the pre-July architecture (two-plane log, standalone mode, login CLI): DESIGN_NOTES.md, README.md, logstore/README.md (now covers the per-bucket Manager), and CLAUDE.md (package map, config keys, seams, dependency list).
  • Refreshes docs/architecture.md and adds docs/diagrams.md — 15 as-built diagrams spanning system context, the package/seam map, the body-blob vs catalog block routes, the PutObject/GetObject/multipart flows, blob and session lifecycles, per-key version storage, catalog GC, principals/proof stores and request authorization, the migrated Postgres schema, and DeleteBucket teardown order.
  • Comment-only touch-ups in module.go, registry/postgres.go, server.go; no behavior change anywhere in the diff.

🤖 Generated with Claude Code

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md with 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

  • ManagerConfig is not declared in config.go (it lives in manager.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 thread logstore/README.md Outdated
Comment thread server.go
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
Comment thread logstore/README.md Outdated
frrist and others added 2 commits August 21, 2026 14:50
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: ash <alan138@gmail.com>
@alanshaw
alanshaw force-pushed the frrist/docs/refresh-and-diagrams branch from 6581bd7 to 3289f57 Compare August 21, 2026 12:50
@alanshaw
alanshaw merged commit bbc4214 into main Aug 21, 2026
13 of 14 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.

3 participants