Skip to content

refactor: move docs to mintlify#162

Merged
oskarkocol merged 9 commits into
mainfrom
chore/move-docs-to-mintlify
May 22, 2026
Merged

refactor: move docs to mintlify#162
oskarkocol merged 9 commits into
mainfrom
chore/move-docs-to-mintlify

Conversation

@oskarkocol
Copy link
Copy Markdown
Collaborator

What does this PR do?

  • swaps vitepress for mintlify
  • less maintenance and better look out of the box

@oskarkocol oskarkocol requested a review from audrzejq as a code owner May 22, 2026 14:33
@oskarkocol oskarkocol linked an issue May 22, 2026 that may be closed by this pull request
@oskarkocol oskarkocol changed the title Chore/move docs to mintlify refactor: move docs to mintlify May 22, 2026
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 under docs/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 export will not work; it should be something like billing_export.
    docs/oss/thinops/connect-providers/gcp.mdx:61
  • BigQuery dataset IDs cannot contain spaces. The example billing export should be updated to a valid dataset ID format such as billing_export.
    docs/oss/thinops/connect-providers/gcp.mdx:149
  • BigQuery dataset IDs cannot contain spaces. The example billing export should be updated to a valid dataset ID format such as billing_export.
    docs/oss/thinops/connect-providers/gcp.mdx:181
  • The example dataset ID billing export contains 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 export contains a space, which is not valid for BigQuery dataset IDs. Use eu_billing_export (or another valid identifier).
    docs/oss/thinops/connect-providers/gcp.mdx:203
  • The example dataset ID billing export contains 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 as billing_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.

Comment thread .npmrc
Comment thread .github/workflows/build-and-test.yaml
Comment thread docs/docs.json
Comment thread docs/docs.json
Comment thread .github/workflows/build-and-test.yaml
@oskarkocol
Copy link
Copy Markdown
Collaborator Author

Copilot has some poor opinions today. LGTM

@oskarkocol oskarkocol merged commit 6d6559d into main May 22, 2026
3 checks passed
@oskarkocol oskarkocol deleted the chore/move-docs-to-mintlify branch May 22, 2026 14:52
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.

chore: move docs to mintlify

2 participants