DOCSP-30327: Added clear link for downloading and installing the driver #703
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
mongoKart
approved these changes
Jun 13, 2023
source/index.txt
Outdated
| @@ -28,7 +28,10 @@ Introduction | |||
| Welcome to the documentation site for the official {+driver-long+}. | |||
| You can add the driver to your application to work with MongoDB | |||
| in JavaScript. Download it using `npm <https://www.npmjs.com/>`__ | |||
| or set up a runnable project by following our Quick Start guide. | |||
| or set up a runnable project by following our Quick Start guide. For more | |||
| information on downloading and installing the {+driver-short+}, see | |||
There was a problem hiding this comment.
I: about vs. on
S:
Suggested change
| information on downloading and installing the {+driver-short+}, see | |
| information about downloading and installing the {+driver-short+}, see |
(BTW, I disagree with the style guide on this point; "on" just sounds better here.)
source/index.txt
Outdated
Comment on lines
30
to
31
| in JavaScript. Download it using `npm <https://www.npmjs.com/>`__ | ||
| or set up a runnable project by following our Quick Start guide. | ||
| or set up a runnable project by following our Quick Start guide. For more |
There was a problem hiding this comment.
Suggestion:
"... work with MongoDB in JavaScript or TypeScript."
Omit the next sentence about "Download" or "Set up a Runnable project" since the next sentence provides that information and the npm link is misleading.
mongoKart
pushed a commit
to mongoKart/docs-node
that referenced
this pull request
Nov 3, 2023
…er (mongodb#703) * DOCSP-30327: Added clear link for downloading and installing the driver. * PR feedback.
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.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-30327
Staging - https://docs-mongodbcom-staging.corp.mongodb.com/node/docsworker-xlarge/DOCSP-30327/
Self-Review Checklist