Skip to content
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.

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

Update mintlify setup from mint.json to docs.json #16962

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Conversation

discdiver
Copy link
Contributor

Allows for more fine-grained control of navigation and is the new way to do things.
Docs build locally in tests.

Generating server API docs has changed a bit. So testing before merge.

Checklist

  • This pull request references any related issue by including "closes <link to issue>"
    • If no issue exists and your change is not a small fix, please create an issue first.
  • If this pull request adds new functionality, it includes unit tests that cover the changes
  • If this pull request removes docs files, it includes redirect settings in mint.json.
  • If this pull request adds functions or classes, it includes helpful docstrings.

@github-actions github-actions bot added the ui-replatform Related to the React UI rewrite label Feb 4, 2025
@discdiver discdiver removed the ui-replatform Related to the React UI rewrite label Feb 4, 2025
Copy link
Contributor

@daniel-prefect daniel-prefect left a comment

Choose a reason for hiding this comment

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

I didn't go line-by-line through docs.json, but I spot checked the deployment and links seem to work. Is it generated from a script?

@discdiver discdiver removed the ui-replatform Related to the React UI rewrite label Feb 4, 2025
@discdiver
Copy link
Contributor Author

The deployment seems fine. Mintlify had a conversion command.

Mintlify-scrape appears to have a path issue bug though, which is causing our server docs to not get built and pre-commit to fail. I'm seeing rapid iterations on mintlify-scrape versions. I'll raise with the team.

@github-actions github-actions bot added the ui-replatform Related to the React UI rewrite label Feb 4, 2025
@discdiver discdiver removed the ui-replatform Related to the React UI rewrite label Feb 4, 2025
@discdiver
Copy link
Contributor Author

cc: @znicholasbrown - saw your PR that updates mint.json to docs.json - if building API server docs will probably need some of what's here - although it's failing ATM, I believe due to Path issues setting working directory with mintlify-scrape or npm.

@discdiver discdiver added the upstream dependency An upstream issue caused by a bug in one of our dependencies label Feb 6, 2025
@discdiver
Copy link
Contributor Author

Mintlify has been alerted to the issue.

After a fix is made, will need to re-run the migration utility to create docs.json and pick up recent changes to mint.json.

Copy link
Contributor

This pull request is stale because it has been open 14 days with no activity. To keep this pull request open remove stale label or comment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs DONT MERGE This PR shouldn't be merged (yet) status:stale upstream dependency An upstream issue caused by a bug in one of our dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants