Skip to content

Conversation

@ethanpalm
Copy link
Collaborator

Documentation changes

This PR documents how to use the CLI migration tool to convert MDX endpoint pages to autogenerated pages.

Closes https://linear.app/mintlify/issue/DOC-140/cli-script-for-migrating-mdx-endpoint-pages


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written
  • Commands and configurations are correct
  • Links resolve to the right destinations
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed
  • Error messages or troubleshooting guidance is helpful

Copy link
Contributor

@mycho2003 mycho2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great; just a few small things I wanted to tweak from my PR description before showing it to the world.

In particular, I think "referencing OpenAPI endpoints" might be a bit vague; it's possible to talk about them in text without generating a page. Maybe semantic, but just want to be safe.

I also think the migration of x-mcp isn't really the focus here, and doesn't need to be highlighted in this section.

Copy link
Contributor

@mycho2003 mycho2003 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good once comments are resolved!

@ethanpalm ethanpalm merged commit 7b84148 into main Aug 15, 2025
4 checks passed
@ethanpalm ethanpalm deleted the xmint-migrate-script branch August 15, 2025 17:58
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.

2 participants