docs: tighten one long sentence to match style guide#5891
Merged
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Summary
Style audit across all MDX files found the docs are largely consistent with the documented style guide (sentence case headings, second person, active voice, consistent click/select terminology). One sentence exceeded 30 words and was rewritten.
Changes
guides/knowledge-base.mdx: split a 40-word sentence in the "Audit existing content" section into shorter, clearer prose. Meaning preserved.Context
Scanned 861 MDX files for heading case, voice, sentence length, and terminology consistency (
click/press,select/choose,log in/sign in, third-person leakage). All other findings were either intentional (style guide examples, proper nouns like GitHub App / Claude Code / Cursor) or not clear style deviations, so they were left as-is per the "when unsure, leave it" rule.Note
Low Risk
Documentation-only wording change with no behavioral or product impact; low risk aside from minor meaning/tonal shifts.
Overview
Tightens wording in
guides/knowledge-base.mdxby rewriting the introductory sentence in Audit existing content to be shorter and clearer while preserving the intent (cataloging existing content to plan migration and verify completeness).Reviewed by Cursor Bugbot for commit b694baa. Bugbot is set up for automated code reviews on this repo. Configure here.