docs: post-Phase-6 sweep — flip aspirational language to past tense#40
Merged
docs: post-Phase-6 sweep — flip aspirational language to past tense#40
Conversation
Pre-Phase-7 audit turned up two dozen stale references where docs
written during phases 5–6c still said things like "Phase 6e will
publish", "lands in Phase 6e", or had unchecked `[ ]` boxes for
sub-phases that have been live for hours-to-days. Plus a few
specifically-wrong references where the published phase number
in the doc didn't match the actual phase that landed (e.g.,
Python publish was 6f, not 6e; Go was 6i, not 6e).
What changes (12 files):
README.md
- Phase 5c/5d/5e SDK descriptions: "PyPI publish lands in
Phase 6e" → "PyPI publish landed in Phase 6f as `sqlrite`",
same correction for Node (6g, scoped) and Go (6i, no
registry).
- Phase 6e/6f/6g/6i checkboxes flipped from [ ] to [x] with
shipped-state notes capturing what each job actually does
now (matrix shapes, OIDC story, scope name decisions).
- Top-of-file docs.rs badge: "Documentation (coming soon)"
pointing at the wrong crate (`sqlrite`, owned by an
unrelated project) → "Rust API docs on docs.rs" pointing
at our actual `sqlrite-engine`.
docs/_index.md
- "Project state" section: added a Phase 6 entry listing
every distribution channel + crate name we publish to.
Updated Phase 5 line from "5a complete; 5b is the
frontier" to "Phase 5 complete except 5f". Set the active
frontier as Phase 7.
docs/roadmap.md
- Phase 5c/5d/5e blurbs: "Phase 6e will publish" →
"Phase 6f/g/i publishes" with correct phase numbers and
present tense.
- Phase 5e blurb: "Phase 6e also tags sdk/go/v*.*.*" →
Phase 6i with the slash-bearing tag rationale.
docs/embedding.md
- Python + Node + Go SDK paragraphs: same future-tense
flips, correct phase numbers.
docs/release-secrets.md
- "Sections 2 + 3 will point at release.yml which lands in
Phase 6d" → "release.yml has been live since Phase 6d".
sdk/python/README.md
- Install: dropped the "(once Phase 6e's CI/CD release
pipeline is live)" parenthetical from the PyPI install.
- Status footer: "Phase 6e lands GitHub Actions" → "Phase
6f's CI publishes wheels" with the actual matrix shape
and OIDC details.
sdk/nodejs/README.md
- Status footer: same shape — Phase 6g, scoped name,
provenance attestations callout.
sdk/go/README.md
- Install paragraph: "Phase 6e will publish prebuilt
libsqlrite_c binaries" → "Phase 6i ships per-platform
libsqlrite_c tarballs at every release".
sdk/go/sqlrite.go
- Two cgo doc-comment edits — the package-level "How it's
wired" block and the cgo build-flag comment — both
flipped from "Phase 6e will ship prebuilt binaries" to
Phase 6i with the actual extract-and-CGO_LDFLAGS workflow.
No engine changes. Pure docs/comments. Cargo unaffected.
go vet -ed cleanly after the sqlrite.go comment edits.
Pre-Phase-7 cleanup, so the next contributor reading the
roadmap or any SDK README sees the actually-current state of
the project, not what someone wrote when they were planning
Phase 6.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
joaoh82
force-pushed
the
docs/phase-6-completion-sweep
branch
from
2b4e49d to
fdfa517
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
1 participant
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.
Why
Pre-Phase-7 audit. Asked myself: "is all the documentation up to date?" Answer was no — about two dozen stale references where docs written during Phases 5 and 6c–6g still said things like "Phase 6e will publish" or had unchecked
[ ]boxes for sub-phases that have been live for hours-to-days.A few were specifically wrong (not just stale tense): the published phase number in the doc didn't match the actual phase that landed. e.g., Python publish was 6f not 6e; Node was 6g not 6e; Go was 6i not 6e. Easy to slip in if you originally drafted the docs assuming all SDK publishes would land in 6e.
What changes
9 files, ~30 line edits, no engine changes. Sample diffs:
@joaoh82/sqlrite(scoped — npm rejected the unscopedsqlritename as too similar tosqlite)"[ ]→[x]with shipped-state notes (matrix shapes, OIDC story, scope name decisions)sqlrite, owned by an unrelated project) → "Rust API docs on docs.rs" pointing at our actualsqlrite-engineSanity checks
go vet ./...clean after sqlrite.go comment editsNot in scope
The v0.1.9 canary (publish-go validation). PR #38 added the publish-go workflow code but the Release PR for v0.1.9 hasn't been merged yet. After this sweep PR merges, dispatch v0.1.9 → that's the final Phase 6 canary. Then Phase 7.
🤖 Generated with Claude Code