Fix passive voice in Speakeasy integration doc#3866
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Fix passive voice in Speakeasy integration doc#3866mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
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
Ran Vale style audit on
integrations/sdks/speakeasy.mdx(modified in PR #189) using the.vale/configuration.Fixed automatically
Requires human judgment
The following issues use passive voice in image alt text, which is a common convention for describing visual elements. Consider if active voice would improve clarity:
Line 29 (Mintlify.Passive - suggestion):
"is emphasized with a red square"appears twice in the alt text"The API Registry tab is emphasized with a red square and the number 1 and the entry for the API is emphasized with a red square and the number 2.""A red square and the number 1 highlight the API Registry tab. A red square and the number 2 highlight the API entry."Line 39 (Mintlify.Passive - suggestion):
"emphasized with a red square"in the alt text"Screenshot showing the combined spec registry entry with the copy URL function emphasized with a red square.""Screenshot showing the combined spec registry entry with a red square highlighting the copy URL function."Note
Low Risk
Low risk documentation-only change that rephrases a single note; no behavior, API, or configuration semantics are altered.
Overview
Updates the Speakeasy integration guide to reword the Combined Spec registry note in active voice, clarifying that the label may be missing unless an automated code sample URL is configured.
Written by Cursor Bugbot for commit 5bb9a13. This will update automatically on new commits. Configure here.