Skip to content

Conversation

@mycho2003
Copy link
Contributor

Documentation changes

This PR updates our docs on creating API pages with instructions for the more flexible use of OpenAPI specs.

  • Conceptual and procedural information on configuring navigation for endpoint pages generated from OpenAPI specs
  • Guide on migrating from individual MDX pages for endpoints to using an OpenAPI spec and the navigation in docs.json

Closes https://linear.app/mintlify/issue/DOC-116/openapi-docs-granular-control


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

@mycho2003 mycho2003 requested a review from ethanpalm August 9, 2025 02:05
Copy link
Contributor Author

@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 great! just one small detail...

Copy link
Collaborator

@ethanpalm ethanpalm left a comment

Choose a reason for hiding this comment

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

Great collaboration ✨

lgtm!

@mycho2003 mycho2003 merged commit a6feb60 into main Aug 12, 2025
4 checks passed
@mycho2003 mycho2003 deleted the openapi-nav-updates branch August 12, 2025 00:27
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.

3 participants