Use .tool-versions variables in getting-started prerequisites#760
Merged
Conversation
Replace hardcoded versions in the Getting Started prerequisites with
{{RUST_VERSION}}, {{NODEJS_VERSION}}, and {{FASTLY_VERSION}} placeholders,
which the VitePress config substitutes from .tool-versions at build time.
Adds NodeJS as an explicit prerequisite so contributors install Node/npm
before the JS build runs.
Supersedes #758. Fixes #747.
14 tasks
ChristianPavilonis
left a comment
ChristianPavilonis
left a comment
Collaborator
There was a problem hiding this comment.
Automated Yesman review: I reviewed PR #760 and found no blocking correctness, security, data-loss, authorization, or severe compatibility issues. The new .tool-versions placeholders match the existing VitePress replacement logic and .tool-versions keys. I left one non-blocking docs navigation question inline.
ChristianPavilonis
approved these changes
Jun 8, 2026
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
2 participants
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.
Fixes #747. Supersedes #758.
Problem
The Getting Started prerequisites listed Rust with a hardcoded version and omitted Node.js/npm entirely. Contributors without Node installed hit a confusing
build.rsfailure when the JS build runs duringcargo build.Approach
Rather than hardcode versions (which drift from the source of truth), this uses the version-substitution mechanism already present in
docs/.vitepress/config.mts, which parses.tool-versionsand replaces{{TOOL_VERSION}}placeholders at markdown-parse time.Changes
docs/guide/getting-started.md{{RUST_VERSION}},{{NODEJS_VERSION}}, and{{FASTLY_VERSION}}; adds NodeJS as an explicit prerequisiteRenders as:
Versions now stay in sync with
.tool-versionsautomatically — no future doc edits needed when toolchain versions bump.Test plan
cd docs && npm run build— substitution renders real versions indist/guide/getting-started.htmlcd docs && npm run format— passes