agent-context: fix wrong claims and API docs gaps in Mintlify skill - #7473
Merged
Merged
Conversation
- global.languages and global.versions require href - don't recommend hidden: false (pages.mdx says remove the field) - add assistant page mode - Icon takes custom images through src, not icon - Steps titleSize includes h4 and applies to Steps; Step title is required - mint test SDK prerequisites and exit codes; analytics plan requirement Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Add spec requirements, navigation-based page generation, MDX pages from a spec (with the multi-spec file path warning, webhooks, openapi-schema), ParamField/ResponseField and per-page playground/authMethod for manual pages, mdx.auth.name, and x-mint fields. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
This branch was successfully deployed
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
Content fixes from a review of the canonical Mintlify skill against the current docs. Each change was checked against the doc source it cites.
Wrong claims corrected
navigation.md:global.languagesandglobal.versionsrequirehref(organize/settings-reference.mdx). The example also adds it.configuration.md: stop recommendinghidden: false. organize/pages.mdx:61 says to remove the field instead.configuration.md: addmode: "assistant"(organize/pages.mdx:176-186).components.md:<Icon>takes custom images throughsrc, noticon(snippets/icons-required.mdx). StepstitleSizeincludesh4and also applies to<Steps>. Steptitleis required. AddsidandnoAnchor(components/steps.mdx).cli.md:mint testSDK prerequisites and exit codes.mint analyticsrequires Pro or Enterprise (cli/commands.mdx).API docs gaps filled (
api-docs.md)$refonly,serversneeded for the playground, security schemes.openapion navigation elements:directory, inheritance,spec.json METHOD /pathentries, hosted-spec redeploys,--local-schema.openapi-schema, and the scraper.ParamField/ResponseField,RequestExample/ResponseExample, per-pageplaygroundandauthMethod(includingnone), andmdx.auth.name.x-mintfields:metadata,content,href,pre/post.Not in this PR
iconType,devin-desktop,banner.color,errors.404.description, and others). These need a docs or schema decision first.type, TabsdefaultTabIndex, Treehighlight, and others), settings gaps (redirect wildcards, SEO fields, integrations), and GraphQL/SDK reference coverage. Happy to follow up.For review
false") and organize/hidden-pages.mdx:38 ("same effect, but avoid in hidden groups") disagree. The skill follows the stricter one..mdfiles in this repo, so these edits haven't had a style check.Validation
npm testandnpm run checkpass.🤖 Generated with Claude Code
Note
Low Risk
Documentation-only edits to agent skill reference files; no runtime or product code changes.
Overview
Updates the Mintlify agent skill reference markdown under
agent-context/context/skills/mintlify/reference/so agents get accurate guidance aligned with current Mintlify docs.Corrections:
navigation.mdnow statesglobal.languagesandglobal.versionsentries requirehref.configuration.mdsays to removehiddeninstead of settingfalse, and documentsmode: "assistant".components.mddocuments<Icon src>for custom images, Steps-leveltitleSize(includingh4), and Stepid/noAnchor.cli.mdaddsmint testagent SDK prerequisites and exit codes, and notes Pro or Enterprise formint analytics.API reference expansion (
api-docs.md): Replaces a minimal top-levelapi.openapistory with spec requirements (3.0/3.1, internal$refonly,servers, security), attachingopenapion navigation elements (directory, mixedpages, spec-qualifiedMETHOD /path, hosted-spec redeploys,--local-schema). Adds MDX from OpenAPI (multi-spec path warning, webhooks,openapi-schema, scraper), richer manual MDX API pages (ParamField/ResponseField, examples, per-pageplayground/authMethod,mdx.auth.name), and detailedx-mintoperation customization.Reviewed by Cursor Bugbot for commit 86a74ce. Bugbot is set up for automated code reviews on this repo. Configure here.