Skip to content

chore(release): finalize Throughline v0.1.0 documentation and publication safeguards - #33

Merged
christophersesugh merged 9 commits into
mainfrom
chore/prepare-v0.1.0-release
Nov 12, 2026
Merged

christophersesugh merged 9 commits into
mainfrom
chore/prepare-v0.1.0-release

Conversation

@christophersesugh

@christophersesugh christophersesugh commented Nov 12, 2026 •

Copy link
Copy Markdown
Contributor

Scope and exact candidate

  • Package: @0xbuff/throughline@0.1.0 (prepublication). Program.version and Trace.version remain 1.
  • Base: main at 2b713bf0f628ea6a728d3ed99513c3349c64a91e.
  • Current PR head: a5327e46473dd927dbf423c2bdc8e2399ce95715.
  • Previously published baseline: v0.0.2 at ab62dd02661701bb2e26014732f765c73bd4e9f7.

Final release preparation

  • Rewrote the root README as a project introduction, installation and runnable compiler/React quick start, and moved the advanced material to docs/user-guide.md. Package-README links target GitHub because docs/ is not included in the npm tarball. Retained the Vite playground and its tests.
  • Moved the signed-tag, manual OIDC stage-only and npm 2FA procedure to docs/releasing.md instead of CONTRIBUTING.md. Kept contributor guidance and support in CONTRIBUTING.md; retained root COPYRIGHT.md, license, conduct and security documents.
  • Standardized CHANGELOG.md to user-facing Added, Changed, Fixed and version sections; finalized docs/release-notes-v0.1.0.md and preserved the concrete upgrade guide.
  • Removed one-off release QA, hardening and readiness Markdown working records, and their references; persistent verification and authorization rules are in docs/releasing.md, and candidate evidence/risks live in this PR. Cleaned AGENTS.md of dated QA findings.
  • Corrected the source-boundary audit after the contributor-guide move. Updated the hierarchy example test to compile the exact fenced example from its new documentation location.
  • Repaired the manual release workflow's ./remark export-map assertion, and added preview/framework/Markdown-host checks to the staged release verification job without granting publishing permission to CI.
  • Addressed and resolved all eleven inline review comments. No domain, trace-schema or package-export removals were introduced.

Verification

  • Current PR CI — success on a5327e4; do not treat earlier green runs as verification of this final commit.
  • Current Firefox/WebKit QA — success on a5327e4.
  • Manual source-document link audit: fourteen changed core/doc files plus seven other Markdown files reviewed; no references to removed documentation were found.
  • Prior source test regression on 155106d6 was the hardcoded README hierarchy fixture; the new test reads and compiles the relocated user-guide fence. The corrected intermediate commit 286b1d7 passed standard CI, Firefox and WebKit as observed, before later documentation-only edits.

Publication boundary

Preparing and resolving documentation review comments does not create a signed release, approve a merge, stage npm or publish a package. The maintained acceptance scope still requires actual rights/history review, supported real-device and assistive-technology acceptance, the defined V-10 learner-comprehension evidence or an explicit approved scope decision, downstream documentation-app integration evidence, compatibility/performance decisions, the final tarball/main CI review and the maintainer's signed-tag and npm 2FA actions. Automated CI passed on the exact final head, but cannot certify those outcomes.

Readiness: documentation and release-preparation changes are complete; the npm publication decision remains Blocked until required acceptance evidence and maintainer authorization are established. See docs/releasing.md.

Comment thread README.md Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread CONTRIBUTING.md Resolved
Comment thread CHANGELOG.md Resolved
Comment thread AGENTS.md Resolved
Comment thread AGENTS.md Resolved
Comment thread scripts/audit-source.mjs Resolved
Comment thread scripts/audit-source.mjs Resolved
Comment thread docs/release-qa-post-v0.0.2.md Resolved
Comment thread docs/release-notes-v0.1.0.md Resolved
@christophersesugh christophersesugh changed the title chore(release): prepare Throughline v0.1.0 and audit public docs chore(release): finalize Throughline v0.1.0 documentation and publication safeguards Nov 12, 2026
@christophersesugh
christophersesugh merged commit f926e9a into main Nov 12, 2026
3 checks passed
@christophersesugh
christophersesugh deleted the chore/prepare-v0.1.0-release branch November 12, 2026 17:21
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