Apply brand tone and writing style fixes#6720
Merged
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. |
ethanpalm
approved these changes
Jul 24, 2026
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
2 participants
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
Minor style and tone fixes across the SDK reference documentation added in #6717 so the new pages match the predominant voice in the repo.
Changes
api-playground/adding-sdk-examples.mdx: tightened the opening sentence (was 33 words) and replaced weak "Here is an example" phrasing with active voice.api-playground/sdk-reference-setup.mdx: split a 39-word sentence in "Keep references up to date" into two shorter sentences.integrations/sdks/speakeasy.mdx: swapped "Navigate to" for "Go to" to match the predominant verb used elsewhere for dashboard navigation.automations/reference.mdx: split a 32-word sentence about support platform selection into two sentences for readability.No headings, code samples, technical details, or API references were changed.
Note
Low Risk
Copy-only documentation changes with no code, config, or API behavior impact.
Overview
Documentation-only edits align newer SDK reference and related pages with the repo’s voice: shorter sentences, active phrasing, and consistent dashboard navigation wording.
SDK and API playground (
adding-sdk-examples.mdx,sdk-reference-setup.mdx,speakeasy.mdx): thex-codeSamplesintro is tightened; example lead-ins use active voice instead of “Here is an example”; the CI “keep references up to date” paragraph is split into two sentences; Speakeasy setup uses Go to instead of Navigate to for the dashboard step.Automations and self-host (
automations/reference.mdx,deploy/self-host.mdx): long sentences on support-platform setup and Git proxy / sizing are broken up for readability without changing headings, samples, or technical details.Reviewed by Cursor Bugbot for commit 324293c. Bugbot is set up for automated code reviews on this repo. Configure here.