Skip to content

API playground docs refresh #723

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 30 commits into from
May 28, 2025
Merged

API playground docs refresh #723

merged 30 commits into from
May 28, 2025

Conversation

@ethanpalm
Copy link
Collaborator

@ethanpalm ethanpalm commented May 22, 2025 •
edited
Loading

This PR updates the content in the API Pages group.

Summary of changes:

  • Playground (overview.mdx)
    • Adds a quickstart and some customization info so that people can get their playground up and running from reading a single article
  • OpenAPI Setup
    • Combines existing OpenAPI setup and writing OpenAPI pages into one, which bumps the content out of a folder into a more discoverable nav bar link
  • Customization (new group)
    • Turns the advanced features page into more specific pages about customization options. Should improve discoverability and removes the ambiguity of "what is advanced?"
    • adds information from https://github.com/mintlify/docs/pull/642/files as a new page
  • MDX
    • Some edits to clarify setup and configuration
  • Set up redirects for any removed pages
  • Fixed broken links

ethanpalm added 24 commits May 20, 2025 09:35
@ethanpalm
add outline
fd072b6
@ethanpalm
update overview
437dd60
@ethanpalm
add a quickstart
da2aeb5
@ethanpalm
update grouping and titles
46d4a36
@ethanpalm
Add getting started info to overview
7c18796
@ethanpalm
update info on adding openAPI doc
43885b4
@ethanpalm
remove repeated link
9721bd4
@ethanpalm
update info on auto-generating pages
54f87d0
@ethanpalm
remove mindsdb image
85e07ea
@ethanpalm
update MDX info
90d2868
@ethanpalm
remove files combined into OpenAPI setup
e240f76
@ethanpalm
add redirects
8fd4c1b
@ethanpalm
rewrite MDX intro
79586d7
@ethanpalm
upate steps
de02346
@ethanpalm
undo reorging MDX content
dcff49e
@ethanpalm
create files for customization group
2776e34
@ethanpalm
update docs.json
fd3c41c
@ethanpalm
add content for complex data types
8929c2e
@ethanpalm
add content for managing page visibility
ed12618
@ethanpalm
Add SDK examples content
be1399d
@ethanpalm
delete advanced features page
4e9f0ae
@ethanpalm
add description for SDK page
3595bac
@ethanpalm
add info on multiple responses
4fcdbdc
@ethanpalm
fix broken links
1b13d76
@ethanpalm ethanpalm marked this pull request as ready for review May 22, 2025 20:50
@ethanpalm ethanpalm marked this pull request as draft May 22, 2025 21:03
@ethanpalm ethanpalm marked this pull request as ready for review May 22, 2025 21:51
baell
baell approved these changes May 27, 2025
View reviewed changes
Copy link
Contributor

@baell baell left a comment

Choose a reason for hiding this comment

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

A few nits and open questions but looks good to me

@ethanpalm ethanpalm merged commit 6f00cd2 into main May 28, 2025
4 checks passed
@ethanpalm ethanpalm deleted the api-playground branch May 28, 2025 18:53
@ethanpalm ethanpalm mentioned this pull request May 28, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@baell baell baell approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@ethanpalm @baell