Skip to content

docs: prepare API v2 reference for future automation - #737

Merged
lavanya-gunreddi merged 3 commits into
mainfrom
luxbarker/api-439-add-github-workflow-to-auto-create-docs-repo-prs-on
Jul 28, 2026
Merged

docs: prepare API v2 reference for future automation#737
lavanya-gunreddi merged 3 commits into
mainfrom
luxbarker/api-439-add-github-workflow-to-auto-create-docs-repo-prs-on

Conversation

@k-nox

@k-nox k-nox commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Configure Mintlify to generate the API v2 reference navigation directly from api-reference-v2/openapi.json.
  • Remove the redundant one-line endpoint MDX wrappers and their hand-maintained navigation entries.
  • Route changes under api-reference-v2/ to the docs code owner.

Important

This PR does not enable automatic docs updates. It is only the docs-repository precursor that prepares the API v2 reference for later automation from Frontdoor. The separate Frontdoor workflow, dedicated GitHub App configuration, and required credentials must land before automatic updates can run.

Verification

  • node scripts/validate-tooltips.js
  • Validated docs.json parses and points the API v2 group at the existing api-reference-v2/openapi.json source and directory.
  • git diff --check origin/main...HEAD
  • Verified .github/CODEOWNERS contains /api-reference-v2/ @lavanya-gunreddi with a trailing newline.

@mintlify

mintlify Bot commented Jul 28, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
runpod-docs 🟢 Ready View Preview Jul 28, 2026, 4:45 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@k-nox
k-nox marked this pull request as ready for review July 28, 2026 16:46
@k-nox
k-nox requested a review from lavanya-gunreddi July 28, 2026 16:46
@lavanya-gunreddi
lavanya-gunreddi merged commit 0e3bc4f into main Jul 28, 2026
3 checks passed
@lavanya-gunreddi
lavanya-gunreddi deleted the luxbarker/api-439-add-github-workflow-to-auto-create-docs-repo-prs-on branch July 28, 2026 19:44
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.

2 participants