Skip to content

docs: 📝 pre-v0.6.0 documentation audit fixes#99

Merged
justapithecus merged 2 commits intomainfrom
andrew/docs/readme-gotchas-touchup
Feb 6, 2026
Merged

docs: 📝 pre-v0.6.0 documentation audit fixes#99
justapithecus merged 2 commits intomainfrom
andrew/docs/readme-gotchas-touchup

Conversation

@justapithecus
Copy link
Owner

@justapithecus justapithecus commented Feb 6, 2026

Summary

  • README.md Gotchas: Remove "Large uploads are now atomic" (feature, not a gotcha); update "Single-writer only" to cover both datasets and volumes
  • Storage Prerequisites: Add "volume" to "dataset or reader" language in both README.md and PUBLIC_API.md
  • IMPLEMENTATION_PLAN.md: Check off all PR1–PR4 items (were unchecked despite being merged)

Test plan

  • Doc-only changes, no code impact

🤖 Generated with Claude Code

justapithecus and others added 2 commits February 6, 2026 15:43
Remove "Large uploads are now atomic" (feature, not a gotcha) and
update single-writer bullet to cover both datasets and volumes.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@justapithecus justapithecus changed the title docs(readme): 📝 clean up Gotchas section docs: 📝 pre-v0.6.0 documentation audit fixes Feb 6, 2026
@justapithecus justapithecus merged commit b27064a into main Feb 6, 2026
5 checks passed
@justapithecus justapithecus deleted the andrew/docs/readme-gotchas-touchup branch February 6, 2026 21:08
justapithecus added a commit that referenced this pull request Feb 7, 2026
#101)

## Summary

Updates `docs/IMPLEMENTATION_PLAN.md` to check off 13 deliverables that
shipped across v0.5.0 (Parquet) and v0.6 PRs (Volume). No code changes.

## Highlights

- Phase 5: mark Parquet codec as implemented (shipped in v0.5.0)
- Phase 6 Volume Deliverables: all 5 items complete (PRs #92#99)
- Phase 6 Dataset Streaming Boundary: all 3 items documented (PR #98)
- Phase 6 Exclusions: all 4 scope assertions confirmed

## Test plan

- [ ] Verify diff is checkbox-only (no prose or code changes)
- [ ] Confirm remaining open items (manifest stats, Zarr) are still
unchecked

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.6 <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