docs: align benchmark prerequisites with promptfoo's Node requirement#205
Open
hamza-ali-shahjahan wants to merge 1 commit into
Open
Conversation
The Prerequisites section listed Node.js 18+, but the Reproduce section (and promptfoo's engine constraint) requires >= 22.22.0, so a reader on Node 18 hits promptfoo's engine error. The local Ollama path uses no Node, so 18+ had no basis. One-line docs change aligning the prerequisite with the existing requirement above it.
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
1 participant
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.
What:
benchmarks/README.mdstates two different Node.js floors. The Reproduce section (Claude) requires Node.js ≥ 22.22.0 (promptfoo's engine constraint), but the Prerequisites section said Node.js (18+). A reader who follows Prerequisites installs Node 18, runsnpx promptfoo, and hits promptfoo's engine error. The local Ollama path (benchmark-local.py) is pure Python and uses no Node, so 18+ had no basis either.Change: One line: align the Prerequisites Node version with the requirement already stated above it (≥ 22.22.0), reusing the existing "promptfoo's engine constraint" wording and cross-linking to Reproduce. Docs-only, no code.
Testing:
npm testis unaffected (docs-only); the suite passes the same with and without this change.