Skip to content

Document storage formats and add a reproducible snapshot demo - #72

Merged
aman-a-shah merged 2 commits into
mainfrom
60-week-9---m1-storage-readiness-object-format-writeup
Nov 18, 2026
Merged

aman-a-shah merged 2 commits into
mainfrom
60-week-9---m1-storage-readiness-object-format-writeup

Conversation

@mahis1067

@mahis1067 mahis1067 commented Nov 17, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Adds Module 1's design writeup and a runnable storage rehearsal covering object identity, nested trees, both merge parents, and exact reads from loose, mixed, and packed-only storage. scripts/demo_storage.py uses a disposable repository, verifies all seven objects through fresh stores, prints the documented results, and cleans up automatically.

Updates packfile API/format limitations and links the demo/writeup from README. Resolves the overlap with #71 by keeping its bounded-cache documentation and canonical revision-pinned measurements; the writeup no longer presents historical Windows observations as a current integrated benchmark.

Related to #60 and #67. The shared project/network checkpoint (#58), a recorded teammate rehearsal, and the final integrated demo remain open acceptance items.

Validation

  • scripts/quality-check.sh: lint, formatting, and all 445 tests pass on Python 3.13.5/macOS, including 82 object tests and network integration coverage.
  • Ran scripts/demo_storage.py and compared stdout exactly with the documented expected output.
  • scripts/build.sh: source distribution and wheel build successfully.
  • Checked documentation links, resolved merge conflicts, and preserved the Bound pack-index caching and verify replacement detection #71 cache implementation and regressions.

Checklist

  • The change is focused and easy to review.
  • The documented demo runs using shipped APIs and disposable fixture data.
  • Format, cache, and performance documentation matches the delivered behavior.
  • No secrets, generated build output, or local-only files are included.

@mahis1067 mahis1067 linked an issue Nov 17, 2026 that may be closed by this pull request
5 tasks
@aman-a-shah aman-a-shah changed the title inital commit Document storage formats and add a reproducible snapshot demo Nov 18, 2026

@aman-a-shah aman-a-shah left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Reviewed the resolved documentation overlap with #71 and verified the executable storage segment. The script checks every object in loose, mixed, and packed-only states through fresh stores; stdout matches the runbook exactly. Lint, formatting, all 445 tests, and the source/wheel build pass. The writeup accurately separates storage measurements from the pending full-project benchmark and leaves teammate rehearsal acceptance in #60/#67.

@aman-a-shah
aman-a-shah merged commit 2e87586 into main Nov 18, 2026
1 check passed
@aman-a-shah
aman-a-shah deleted the 60-week-9---m1-storage-readiness-object-format-writeup branch November 18, 2026 15:48
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.

Week 9 - M1: Storage readiness + object-format writeup

2 participants