Raise the Node.js floor to match the driver it tells you to install - #162
Merged
guanzhousongmicrosoft merged 2 commits intoAug 25, 2026
Conversation
The Node.js quick start listed 'Node.js 18 or later' as its prerequisite and then ran an unpinned 'npm install mongodb'. The current driver requires Node >=20.19, so a reader on 18 satisfies the documented prerequisite and then fails at install time with an engine error. The same floor was corrected in documentdb/docs; this is the website-owned copy of the same page. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: f18515db-c52f-4197-aa50-d81359c7c763 Signed-off-by: Guanzhou Song <guanzhou.song@gmail.com>
Two findings from the second review pass, both verified against the shipped image. The Docker troubleshooting list and the getting-started index both told readers to restart with --log-level debug for more detail. The site's own DocumentDB Local page documents that flag as a known issue: the value is validated at startup but does not change what the container logs, and DOCUMENTDB_LOG_LEVEL is the control that works. The advice was also impossible as written for a second reason -- docker restart cannot change a container's arguments or environment. Point at the env var and say the container has to be re-created. The previous round corrected the sample-data claim on the Docker and mongosh guides but left the Python and VS Code guides saying 'if you started with DocumentDB Local sample data'. Neither page's docker run includes --init-data true, so that condition is never true for someone following those pages, and the reader is left unsure whether an empty result is a mistake. State that it is opt-in, as the other two guides now do. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: f18515db-c52f-4197-aa50-d81359c7c763 Signed-off-by: Guanzhou Song <guanzhou.song@gmail.com>
guanzhousongmicrosoft
approved these changes
Aug 25, 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
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.
The Node.js quick start listed:
as its prerequisite, and then ran an unpinned
npm install mongodb. The current driver requires Node>=20.19, so a reader who satisfies the documented prerequisite fails at install time with an engine error.Found by the second review pass. The same floor was corrected in
documentdb/docs; this is the website-owned copy of the same page, which was missed because the two live in different content layers — the docs repo is cloned at build time, while this page is a TypeScript template literal inarticleService.ts.npm test130 passed ·tsc --noEmitclean.Related
documentdb/docs#72 — the docs-repo half, plus two samples broken by the previous fix round.