Skip to content

docs: fix Agents reference heading in MDX - #668

Merged
jdchawla29 merged 1 commit into
mainfrom
codex/docs-mdx-agent-anchor
Sep 17, 2026
Merged

jdchawla29 merged 1 commit into
mainfrom
codex/docs-mdx-agent-anchor

Conversation

@jdchawla29

@jdchawla29 jdchawla29 commented Sep 17, 2026

Copy link
Copy Markdown
Collaborator

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-agent anchor 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 --check passes. The preview still logs an unrelated Invalid image buffer warning.

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-agent keep working. No changes to create_agent signatures or examples.

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

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 17, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-17T01:43:14.637293Z 07bea84 PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@jdchawla29
jdchawla29 merged commit 3123587 into main Sep 17, 2026
8 checks passed
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