DOCSP-46206: Add code guidelines page #187
Merged
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
✅ Deploy Preview for mongodb-docs-meta ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
cbullinger
force-pushed
the
docsp-46206-code-guidelines
branch
from
df59662 to
0dc2a09
Compare
jeff-allen-mongo
requested changes
Apr 14, 2025
There was a problem hiding this comment.
@cbullinger thanks for these updates! Leaving a few suggestions in the comments.
stephmarie17
requested changes
Apr 14, 2025
Co-authored-by: Jeff Allen <jeffrey.allen@10gen.com> Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com>
Co-authored-by: Jeff Allen <jeffrey.allen@10gen.com> Co-authored-by: Stephanie <52582720+stephmarie17@users.noreply.github.com>
cbullinger
commented
Apr 22, 2025
cbullinger
commented
Apr 22, 2025
stephmarie17
approved these changes
Apr 22, 2025
jeff-allen-mongo
approved these changes
Apr 22, 2025
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 Process
Please read the
Style Guide Review Process
wiki page.
Contributors should take the following actions:
they will merge the PR and notify you of the merge in the Slack channel.
Pull Request Description
Add new top-level page (similar to the SEO guidelines) for general code example guidelines, including newly defined code example categories and LLM considerations.
This is the initial piece of a larger effort to formalize code-specific guidelines for our docs
JIRA URL: https://jira.mongodb.org/browse/DOCSP-46206
Staging URL: https://docs-mongodbcom-staging.corp.mongodb.com/drivers/docsworker-xlarge/NNNNN/