ci: add GitHub Pages workflow for API docs#174
Conversation
This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
There was a problem hiding this comment.
Devin Review found 1 potential issue.
🐛 1 issue in files not directly in the diff
🐛 Workflow file is empty — no CI pipeline will run (.github/workflows/api-docs.yml:1)
The file .github/workflows/api-docs.yml is 0 bytes (empty), despite the commit message stating it should "Deploy the Scalar API reference to GitHub Pages on pushes to main when openapi.json or docs/api/ changes." An empty workflow file means GitHub Actions will not execute any workflow for API docs deployment. This appears to be a commit where the file was created but its contents were never written.
View 1 additional finding in Devin Review.
Sync openapi.json with upstream and update quinn-proto from 0.11.13 to 0.11.14 to fix RUSTSEC-2026-0037 (DoS via invalid QUIC transport parameters). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add a static HTML page that renders the OpenAPI spec using Scalar's CDN-hosted API reference component. AI agent and client button are disabled for a clean, focused documentation experience. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Deploy the Scalar API reference to GitHub Pages on pushes to main when openapi.json or docs/api/ changes. Copies both files into a flat _site directory for the Pages artifact. Requires enabling GitHub Pages with "GitHub Actions" as the source in the repository settings. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
sachiniyer
force-pushed
the
chore/sync-openapi-and-deps
branch
from
491531b to
c8398f5
Compare
sachiniyer
force-pushed
the
ci/api-docs-pages-v3
branch
from
7ad3adc to
e5f024a
Compare
There was a problem hiding this comment.
Devin Review found 2 new potential issues.
🐛 1 issue in files not directly in the diff
🐛 Workflow file is empty — no CI pipeline will run (.github/workflows/api-docs.yml:1)
The file .github/workflows/api-docs.yml is 0 bytes (empty), despite the commit message stating it should "Deploy the Scalar API reference to GitHub Pages on pushes to main when openapi.json or docs/api/ changes." An empty workflow file means GitHub Actions will not execute any workflow for API docs deployment. This appears to be a commit where the file was created but its contents were never written.
View 2 additional findings in Devin Review.
| <script src="https://cdn.jsdelivr.net/npm/@scalar/api-reference"></script> | ||
| <script> | ||
| Scalar.createApiReference("#app", { | ||
| url: "./openapi.json", |
There was a problem hiding this comment.
🔴 Incorrect relative path to openapi.json — file is at repo root, not in docs/api/
The HTML page at docs/api/index.html references ./openapi.json (line 13), which resolves to docs/api/openapi.json. However, the actual openapi.json lives at the repository root (openapi.json), as confirmed by xtask/src/main.rs:5 (const OPENAPI_PATH: &str = "openapi.json"). Since there is no build step that copies the file into docs/api/ (the workflow file is empty), this reference will 404 at runtime and the Scalar API reference page will fail to load any spec.
Prompt for agents
The url in docs/api/index.html line 13 is set to "./openapi.json" but the openapi.json file lives at the repository root. Either:
1. Change the relative path to "../../openapi.json" to point to the repo root, OR
2. Add a build/deploy step in the (currently empty) .github/workflows/api-docs.yml that copies openapi.json into docs/api/ before deployment, OR
3. Use an absolute URL (e.g. the upstream https://api.detail.dev/public/v1/openapi.json).
Option 2 is likely intended since the workflow file was supposed to handle deployment.
Was this helpful? React with 👍 or 👎 to provide feedback.
1 participant
Deploy the Scalar API reference to GitHub Pages on pushes to main
when openapi.json or docs/api/ changes. Copies both files into a
flat _site directory for the Pages artifact.
Requires enabling GitHub Pages with "GitHub Actions" as the source
in the repository settings.
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com