docs: add source file basics guidance - #193
Open
ogormans-deptstack wants to merge 1 commit into
Open
Conversation
Add source-file basics guidance covering character set, line length, line endings, tabs/indentation, naming conventions, and Snooty usage. Refs mongodb#88 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
👷 Deploy request for mongodb-docs-meta pending review.Visit the deploys page to approve it
|
Open
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.
Jira
N/A (external contribution)
Summary
This PR adds docs-as-code source file basics guidance as a modernization follow-up in the same area where legacy build-toolchain instructions were removed in #192.
Changes
source/style-guide/style/source-file-basics.txtsource/style-guide/style/index.txtWhy this helps modernization
PR #192 removed outdated Giza/Sphinx install guidance. This PR complements that cleanup by providing a concise, toolchain-agnostic baseline for contributors editing source files in current docs workflows.
Validation / checks context
From current
docs-metaPR checks, this change is expected to go through:Refs #88