docs(NODE-7396): document experimental features#4873
Draft
RaschidJFR wants to merge 1 commit intomongodb:mainfrom
Draft
docs(NODE-7396): document experimental features#4873RaschidJFR wants to merge 1 commit intomongodb:mainfrom
RaschidJFR wants to merge 1 commit intomongodb:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for all experimental features in the MongoDB Node.js Driver v7.1.0. The documentation catalogues 31 experimental annotations across 9 major feature categories, providing developers with a single reference point for understanding which APIs may undergo breaking changes in future releases.
Changes:
- Added EXPERIMENTAL_FEATURES.md documenting all experimental features with descriptions, code examples, source file references, and stability notes
- Organized features into logical categories including resource management, timeouts, encryption, and strict TypeScript types
- Included practical usage examples and warnings about production readiness for each experimental feature
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,359 @@ | |||
| # MongoDB Node.js Driver - Experimental Featuress | |||
There was a problem hiding this comment.
Typo in the title: "Featuress" should be "Features" (remove the extra 's').
Suggested change
| # MongoDB Node.js Driver - Experimental Featuress | |
| # MongoDB Node.js Driver - Experimental Features |
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.
Description
Summary of Changes
Adds EXPERIMENTAL_FEATURES.md documenting all 31 experimental annotations in the driver (v7.1.0). Includes descriptions, code examples, and source links for each experimental feature.
Notes for Reviewers
Need a hand reviewing the accuracy of the content added.
Release Highlight
Release notes highlight
Added EXPERIMENTAL_FEATURES.md providing comprehensive documentation of all experimental features in the driver, including usage examples and stability notes.
Double check the following
npm run check:lint)type(NODE-xxxx)[!]: descriptionfeat(NODE-1234)!: rewriting everything in coffeescriptChanges are covered by testsNew TODOs have a related JIRA ticket