Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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.
Summary
Rewrite the developer documentation around choosing an SDK, installing it, running a complete parameterized query, and keeping data between runs. Reorganize all 41 authored public pages and the root plus seven SDK READMEs into quickstarts, task guides, and API reference, with examples and lifecycle constraints checked against the current checkout.
docs-version.jsonwith the source revision and product/version set. Document clean-commit snapshots for independently released SDKs; keep release synchronization from rewriting MDX tokens.Release Intent
feat:,fix:,perf:,refactor:,revert:, or a breaking!.Documentation targets the checkout's APIs and package versions, assuming those versions are published. No runtime behavior, package version, or platform support floor changes.
Verification
pnpm --dir src/docs check,build, andsmoke: 44 documentation routes and 49 exported HTML files.moon run release-tools:unit release-tools:graph-unitusing pinned Moon 2.5.4 after the release-selection fix, plus 12 focused publication-plan/release-intent tests and the earlier 19 release/version/platform tests.git diff --check.Full cross-platform SDK execution was not performed: native Rust execution requires the unavailable native library, and Apple/Android examples and packaging were source-reviewed. The workspace doctor and full product packaging lanes were not run. On head
c05699e31771e46c132d2384c3f64f8425c849f7, hosted Release Intent, Affected Work, and the combined Docs Build/Check/Smoke job passed in CI run 34210452406. Remaining hosted jobs are still running; the full Required/Qualified gates are not yet confirmed.See
docs/maintainers/docs-rewrite-audit.mdfor the per-file review and validation boundaries, andsrc/docs/README.mdfor version and snapshot authoring instructions.Historical release validation follow-up
Retain the four legacy SDK MDX version rules for strict historical release-commit validation only. Future release synchronization continues to use centralized MDX version tokens. A regression test accepts version-only historical substitutions and rejects unrelated prose edits.
On head
f3407b49cb2d50741c3e31e4ed3c45a8a679a0be, hosted Planning / Release Intent, Planning / Affected Work, and Checks / Policy passed in CI run 34212275192. Localrelease-tools:metadataandrelease-tools:unitboth passed, along with 21 focused tests. Remaining build/test jobs are still running; Required/Qualified are not yet confirmed.Published-package verification
Fresh consumer checks after publication supersede the earlier execution limitations where noted in
docs/maintainers/published-docs-verification.md. WASIX TypeScript and Rust quickstarts run; TypeScript persistence, transactions, backup/restore, pgTAP, Worker execution, and logical dump/restore pass. Native Rust runs with the complete GitHub archive and explicit environment setup, now documented. Native TypeScript 0.2.0 fails fresh initialization on Linux x64 under both Node and Bun; the public docs now disclose this release defect. Swift/Kotlin/React Native versions and API sources were verified, but mobile applications and browser storage were not executed. Docs check/build/smoke pass after these corrections.