Repository navigation
Align onboarding docs with the published v0.8 SDK - #237
Merged
Merged
Conversation
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.
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
9c926aa10c7ec915deb76f5782be11137988a29a68d379bc194a11f8e3c08bab). On macOS/JDK 26.0.1, extracted-SDKsprig version,sprig doctor --json,sprig capabilities --json,sprig init hello,sprig resolveandsprig runall exited 0; the starter printedHello, Sprig!.ColinHouse.sprig-languageversion 0.3.1.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 --checkandgit diff --cached --check: passed.python3 scripts/build.pyused macOS's Python 3.9.6 and failed becausePath.write_text(newline=...)is unavailable. The repository requires Python 3.12+; the build and final gates above used Python 3.12 and passed.The canonical contributor gate's constituent scripts were run individually as listed above. No existing assertions or golden outputs were weakened or changed.
Scope
AI assistance
Prepared with AI coding agents: the documentation and release metadata updates, the consistency guard, and the commands above.
Review checklist