Skip to content

Align onboarding docs with the published v0.8 SDK - #237

Merged
ColinHouse merged 1 commit into
mainfrom
docs/release-onboarding
Oct 9, 2026
Merged

ColinHouse merged 1 commit into
mainfrom
docs/release-onboarding

Conversation

@ColinHouse

Copy link
Copy Markdown
Owner

Change and motivation

Align the README and Chinese/English home, installation, tutorial, tooling and editor pages with the published v0.8.0-beta.1 SDK and Marketplace extension. Pre-release preparation left the public onboarding path claiming the latest SDK was v0.7.1, tutorial readers had to build from source, and the extension was unpublished. The current SDK requires a separate JDK 21+; its compiler version, language version and extension version are independent.

Record the actual v0.8 release artifact and workflow evidence, preserve the v0.7.1 validation record unchanged in a versioned file, and update main's latest-published metadata. Expand the existing consistency gate to cover onboarding pages, Marketplace installation instructions and chapter 23 version outputs.

Evidence

  • Fresh official release ZIP: SHA-256 matched the published checksum and GitHub asset digest (9c926aa10c7ec915deb76f5782be11137988a29a68d379bc194a11f8e3c08bab). On macOS/JDK 26.0.1, extracted-SDK sprig version, sprig doctor --json, sprig capabilities --json, sprig init hello, sprig resolve and sprig run all exited 0; the starter printed Hello, Sprig!.
  • GitHub release v0.8.0-beta.1, its tag commit, assets and successful release workflow 37806498884 were checked. Marketplace lists ColinHouse.sprig-language version 0.3.1.
  • New required-marker checks reject the old content of all 13 affected onboarding/editor/tutorial pages and accept the new content. The historical validation file was compared byte-for-byte with the original record.
  • python3.12 scripts/build.py: passed.
  • python3.12 scripts/test.py: 187 gates/cases passed, 0 failed on the final edits.
  • python3.12 scripts/test-grammar.py: 53 syntax cases passed.
  • python3.12 scripts/check-docs.py: 503 snippets passed, 676 displayed outputs checked, 0 differ, VitePress production build passed, 290 Markdown files / 1399 link targets passed.
  • python3.12 scripts/check-editor.py: TextMate, real CLI/JVM, language server and VSIX packaging passed. The isolated VS Code Extension Host was not run.
  • git diff --check and git diff --cached --check: passed.
  • Environment correction: the first python3 scripts/build.py used macOS's Python 3.9.6 and failed because Path.write_text(newline=...) is unavailable. The repository requires Python 3.12+; the build and final gates above used Python 3.12 and passed.
  • Evidence levels: syntax, static checking, javac/JVM, documentation build/link checks and extension packaging. The fresh downloaded-SDK smoke check does not establish manual Windows or complete editor-interaction coverage, and did not test the live managed upgrade path.

The canonical contributor gate's constituent scripts were run individually as listed above. No existing assertions or golden outputs were weakened or changed.

Scope

  • Language semantics changed? No. Only documentation, one release-status metadata field, and documentation consistency coverage.
  • Dependencies/licensing changed? No.
  • No release tag, Marketplace publication, existing GitHub release body, or website deployment was changed. Outreach contacts and email drafts are local planning material outside this repository.

AI assistance

Prepared with AI coding agents: the documentation and release metadata updates, the consistency guard, and the commands above.

Review checklist

  • I understand and reviewed the diff.
  • Existing regression assertions/goldens are preserved or a changed expectation is justified.
  • User-visible documentation and stable diagnostics are current.
  • The canonical contributor gate passed, or failures are explicitly recorded above.

@ColinHouse
ColinHouse merged commit b007b0f into main Oct 9, 2026
14 checks passed
@ColinHouse
ColinHouse deleted the docs/release-onboarding branch October 9, 2026 09:10
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