docs: fix Agents reference heading in MDX - #668
Merged
Merged
Conversation
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
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.
The Agents reference fails the local Mintlify MDX parser at
## create_agent {#create-agent}. Use the standard Markdown heading## Create agent, which automatically generates the same#create-agentanchor without custom-ID syntax. The function signature and examples remain unchanged.Validation: the Agents page renders in Mintlify with HTTP 200 and
h2#create-agent; Training and Runtime render with their existing links to that fragment;git diff --checkpasses. The preview still logs an unrelatedInvalid image bufferwarning.One-line SDK documentation fix. The monorepo submodule pointer is unchanged.
Note
Low Risk
Documentation-only heading syntax change with no runtime or API impact.
Overview
Fixes a Mintlify MDX parse failure on the Agents reference by replacing
## create_agent {#create-agent}with## Create agent.Custom
{#create-agent}heading IDs are removed in favor of Mintlify’s default slug, so existing links from Runtime and Training to/v6/reference/agents#create-agentkeep working. No changes tocreate_agentsignatures or examples.Reviewed by Cursor Bugbot for commit 07bea84. Bugbot is set up for automated code reviews on this repo. Configure here.