Skip to content

docs: annotate cards/intro snippet to trigger Mintlify redeploy#491

Open
AaryamanBhute wants to merge 1 commit into
mainfrom
05-22-docs_annotate_cards_intro_snippet_triggers_mintlify_redeploy_to_pick_up_stainless_cards_
Open

docs: annotate cards/intro snippet to trigger Mintlify redeploy#491
AaryamanBhute wants to merge 1 commit into
mainfrom
05-22-docs_annotate_cards_intro_snippet_triggers_mintlify_redeploy_to_pick_up_stainless_cards_

Conversation

@AaryamanBhute
Copy link
Copy Markdown
Contributor

Summary

Tiny snippet annotation to force a Mintlify redeploy. PR #490 only touched openapi/openapi.yaml (outside mintlify/), so Mintlify's GitHub integration skipped the deploy on that merge and the production API reference is still missing the Cards group.

Touching a file under mintlify/ here triggers an actual Mintlify deploy, which re-fetches Stainless's now-updated openapi.documented.yml (already serves Cards endpoints) and bakes it into the production build.

Test plan

  • Mintlify Deployment check passes (not skipped) on merge
  • grid.lightspark.com/api-reference shows the Cards tag group after the deploy completes

@vercel
Copy link
Copy Markdown

vercel Bot commented May 22, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment May 22, 2026 9:41pm

Request Review

@mintlify
Copy link
Copy Markdown
Contributor

mintlify Bot commented May 22, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
Grid 🟢 Ready View Preview May 22, 2026, 9:42 PM

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 22, 2026

Greptile Summary

This PR adds a JSX comment to mintlify/snippets/cards/intro.mdx solely to trigger a Mintlify redeploy. PR #490 updated openapi/openapi.yaml outside the mintlify/ directory, causing Mintlify's GitHub integration to skip the deploy, leaving the Cards API group absent from production docs.

  • Adds a descriptive comment header to intro.mdx so the file change falls within Mintlify's watch path, prompting a redeploy that picks up the already-updated openapi.documented.yml with Cards endpoints.
  • No content, logic, or configuration is otherwise modified.

Confidence Score: 5/5

Safe to merge — the change is a single JSX comment addition with no functional modifications to content, navigation, or configuration.

The only change is adding a descriptive comment to an MDX snippet file. Nothing about the rendered output, imports, or Mintlify configuration is altered; the sole effect is triggering a Mintlify deploy.

No files require special attention.

Important Files Changed

Filename Overview
mintlify/snippets/cards/intro.mdx Adds a JSX comment header to trigger Mintlify redeploy; no content changes.

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant Mintlify
    participant Stainless

    Dev->>GH: "Merge PR #490 (openapi.yaml only)"
    GH-->>Mintlify: Webhook (no mintlify/ files changed)
    Mintlify-->>Mintlify: Skip deploy

    Dev->>GH: "Merge PR #491 (intro.mdx comment added)"
    GH->>Mintlify: Webhook (mintlify/ file changed)
    Mintlify->>Stainless: Fetch openapi.documented.yml
    Stainless-->>Mintlify: Returns updated spec (with Cards endpoints)
    Mintlify-->>Mintlify: "Build & deploy production docs"
    Mintlify-->>Dev: Cards group visible at grid.lightspark.com/api-reference
Loading

Reviews (1): Last reviewed commit: "docs: annotate cards/intro snippet (trig..." | Re-trigger Greptile

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.

1 participant