Skip to content

Documentation quality check: contextual menu query type and Speakeasy verify#6752

Open
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/97b9ea5c
Open

Documentation quality check: contextual menu query type and Speakeasy verify#6752
mintlify[bot] wants to merge 2 commits into
mainfrom
mintlify/97b9ea5c

Conversation

@mintlify

@mintlify mintlify Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Fixes two gaps found during a quality review of English MDX files updated between 2026-07-24 and 2026-07-25.

Changes

ai/contextual-menu.mdx

  • Gap: The query field under href was documented as type="object" and marked required, but the schema and the example both use an optional array of {key, value} objects. Readers could not tell whether query should be an object or an array.
  • Fix: Corrected the type to object[] and removed the required flag so the docs match the validation schema and the accompanying example.

integrations/sdks/speakeasy.mdx

  • Gap: The page ended after the config step with no way to verify success or troubleshoot missing snippets, and it did not explain how the language coverage is determined.
  • Fix: Added a "Verify the integration" section that tells readers to check the playground after redeploy, notes that available languages match the Speakeasy SDK targets, and lists the most common causes when snippets do not appear (wrong spec URL, private URL, missing automated code sample URL).

Context

Other pages reviewed in scope either had no clear gaps or had gaps that required plan/pricing, timeline, or provider-specific information that could not be safely written without domain confirmation, so they were left unchanged.


Note

Low Risk
Documentation-only corrections with no runtime, auth, or data-handling changes.

Overview
Aligns contextual menu custom href docs with the schema and examples: query is documented as an optional object[] (array of {key, value} params) instead of a required single object, in English plus es, fr, and zh locales.

Adds a Verify the integration section to the Speakeasy SDK guide (same locales) so readers can confirm playground snippets after redeploy, understand that languages follow Speakeasy SDK targets, and troubleshoot missing snippets (combined *-with-code-samples URL, public reachability, automated code sample URL).

Reviewed by Cursor Bugbot for commit 05546e8. Bugbot is set up for automated code reviews on this repo. Configure here.

@mintlify

mintlify Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Jul 25, 2026, 10:12 AM

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Jul 25, 2026, 10:13 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
mintlify 🟡 Building Jul 25, 2026, 10:10 AM

@mintlify

mintlify Bot commented Jul 25, 2026

Copy link
Copy Markdown
Contributor Author

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
tomee 🟡 Building Jul 25, 2026, 10:10 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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