refactor: move docs to mintlify#162
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the documentation site from VitePress to Mintlify by removing the old VitePress source/config and introducing Mintlify’s docs.json navigation plus new MDX content under docs/oss/thinops.
Changes:
- Removed VitePress configuration and markdown sources under
docs/src/and provider docs underdocs/src/connect-providers/. - Added Mintlify configuration (
docs/docs.json,.mintignore) and new MDX pages for OSS ThinOps docs, including updated image embeds. - Updated CI docs job to run Mintlify broken-link checks and added new static assets (logos/images).
Reviewed changes
Copilot reviewed 21 out of 39 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/src/index.md | Removed VitePress landing page content (replaced by Mintlify MDX elsewhere). |
| docs/src/focus-specification.md | Removed VitePress FOCUS spec page (replaced by Mintlify MDX). |
| docs/src/connect-providers/index.md | Removed VitePress provider index page (replaced by Mintlify MDX). |
| docs/README.md | Removed VitePress-oriented local dev instructions. |
| docs/pnpm-lock.yaml | Removed VitePress dependency lock content (docs no longer uses pnpm). |
| docs/package.json | Switched scripts from VitePress to Mintlify npx commands. |
| docs/oss/thinops/index.mdx | Added Mintlify MDX OSS overview page. |
| docs/oss/thinops/getting-started/sync-providers.mdx | Updated/expanded Mintlify MDX content and formatting. |
| docs/oss/thinops/getting-started/deployment.mdx | Updated frontmatter and formatting for Mintlify. |
| docs/oss/thinops/focus-specification.mdx | Added Mintlify MDX FOCUS spec reference. |
| docs/oss/thinops/connect-providers/openai.mdx | Updated OpenAI provider guide to Mintlify MDX components and revised wording. |
| docs/oss/thinops/connect-providers/index.mdx | Added Mintlify MDX provider index with new image paths. |
| docs/oss/thinops/connect-providers/gcp.mdx | Updated GCP provider guide; switched to Mintlify components and new asset links. |
| docs/oss/thinops/connect-providers/azure.mdx | Updated Azure provider guide; switched to Mintlify components and new asset links. |
| docs/oss/thinops/connect-providers/aws.mdx | Updated AWS provider guide; switched to Mintlify components and new asset links. |
| docs/logo/light.svg | Added new logo (light). |
| docs/logo/dark.svg | Added new logo (dark). |
| docs/images/oss/thin-ops/aws-1.jpg | Added new image asset. |
| docs/docs.json | Added Mintlify site configuration and navigation. |
| docs/.vitepress/config.mts | Removed VitePress config. |
| docs/.mintignore | Added Mintlify ignore rules. |
| docs/.markdownlintignore | Removed markdownlint ignore (docs tooling changed). |
| docs/.markdownlint.json | Removed markdownlint config (docs tooling changed). |
| .npmrc | Added pnpm store-dir override. |
| .github/workflows/build-and-test.yaml | Updated docs CI job to run Mintlify broken-links check. |
Files not reviewed (1)
- docs/pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (11)
docs/oss/thinops/connect-providers/gcp.mdx:34
- BigQuery dataset IDs cannot contain spaces. The example
billing exportwill not work; it should be something likebilling_export.
docs/oss/thinops/connect-providers/gcp.mdx:61 - BigQuery dataset IDs cannot contain spaces. The example
billing exportshould be updated to a valid dataset ID format such asbilling_export.
docs/oss/thinops/connect-providers/gcp.mdx:149 - BigQuery dataset IDs cannot contain spaces. The example
billing exportshould be updated to a valid dataset ID format such asbilling_export.
docs/oss/thinops/connect-providers/gcp.mdx:181 - The example dataset ID
billing exportcontains a space, which is not valid for BigQuery dataset IDs. Use an underscore (e.g.,billing_export).
docs/oss/thinops/connect-providers/gcp.mdx:192 - The example dataset ID
eu_billing exportcontains a space, which is not valid for BigQuery dataset IDs. Useeu_billing_export(or another valid identifier).
docs/oss/thinops/connect-providers/gcp.mdx:203 - The example dataset ID
billing exportcontains a space, which is not valid for BigQuery dataset IDs. Use an underscore (e.g.,billing_export).
docs/oss/thinops/connect-providers/gcp.mdx:246 - The sample output uses
Dataset ID: billing export, but BigQuery dataset IDs cannot contain spaces. This should use a valid identifier such asbilling_export.
docs/oss/thinops/connect-providers/gcp.mdx:255 - This example suggests a BigQuery dataset ID containing a space (
billing export), which is invalid. Use an underscore (e.g.,billing_export) so the example reflects a real dataset ID.
docs/oss/thinops/connect-providers/azure.mdx:31 - Azure Storage resources are referred to as a "storage account name", not a "storage username". Using the correct term avoids confusion when users follow the Azure Portal UI.
docs/oss/thinops/connect-providers/azure.mdx:95 - Azure Storage uses the term "storage account name". "Storage username" is not an Azure concept and may confuse readers.
docs/oss/thinops/connect-providers/azure.mdx:161 - This should refer to the Azure "storage account name" (not "storage username").
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Collaborator
Author
|
Copilot has some poor opinions today. LGTM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What does this PR do?
vitepressformintlify