Skip to content

Fix passive voice in Speakeasy integration doc#3866

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fix-1772224982
Closed

Fix passive voice in Speakeasy integration doc#3866
mintlify[bot] wants to merge 1 commit intomainfrom
vale-style-fix-1772224982

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Feb 27, 2026

Summary

Ran Vale style audit on integrations/sdks/speakeasy.mdx (modified in PR #189) using the .vale/ configuration.

Fixed automatically

  • Line 33: Changed passive voice "is not labeled" to active voice "does not show the label"

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:

  1. Line 29 (Mintlify.Passive - suggestion): "is emphasized with a red square" appears twice in the alt text

    • Current: "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."
    • Option: "A red square and the number 1 highlight the API Registry tab. A red square and the number 2 highlight the API entry."
  2. Line 39 (Mintlify.Passive - suggestion): "emphasized with a red square" in the alt text

    • Current: "Screenshot showing the combined spec registry entry with the copy URL function emphasized with a red square."
    • Option: "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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant