Automated SEO fixes: preserve Artifacts title and fix API reference#76
Conversation
Update frontmatter title from 'Artifacts' to 'Artifact commands' to meet the 20-char minimum for <title> tags. Sidebar label remains 'Artifacts'. Co-Authored-By: Oz <oz-agent@warp.dev>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-Authored-By: Oz <oz-agent@warp.dev>
petradonka
changed the title
|
I'm starting a first review of this pull request. You can view the conversation on Warp. I completed the review and no human review was requested for this pull request. Comment Powered by Oz |
![oz-for-oss[bot]](https://avatars.githubusercontent.com/in/3450139?s=60&v=4){kind=small}
There was a problem hiding this comment.
Overview
This PR updates the docs SEO audit workflow to recognize standalone Astro routes, preserves the intentional short Artifacts title, and adjusts the standalone API reference shell/topbar.
Concerns
- The API reference still loads a third-party Scalar bundle from jsDelivr, but the PR removes subresource integrity instead of replacing it with a hash for the upgraded version.
Security
- Loading the CDN script without SRI weakens the supply-chain protection for a script that executes on docs.warp.dev.
Verdict
Found: 0 critical, 1 important, 0 suggestions
Request changes
Comment /oz-review on this pull request to retrigger a review (up to 3 times on the same pull request).
Powered by Oz
| })(); | ||
| </script> | ||
| <script is:inline src="https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.52.2" integrity="sha384-lQKcRGSJRRAHGfUX6ajRHvcWdCi8lgITkVTftrhsN5rVkWmsjVaW0encVdMEhGhi" crossorigin="anonymous"></script> | ||
| <script is:inline src="https://cdn.jsdelivr.net/npm/@scalar/api-reference@1.57.1" crossorigin="anonymous"></script> |
There was a problem hiding this comment.
@scalar/api-reference@1.57.1 or self-host/pin the bundle instead.
hongyi-chen
left a comment
hongyi-chen
left a comment
There was a problem hiding this comment.
LGTM but might be worth looking into that one important Oz comment / triggering another review
Good callout. I've intentionally done that, because https://docs.warp.dev/api doesn't work in prod right now, and it doesn't quite make sense to have SRI on externally hosted stuff that could change. Will merge this in to fix prod. Thanks! |
2 participants
Automated SEO fixes: preserve Artifacts title and fix API reference
What changed
src/content/docs/reference/cli/artifacts.mdxto usetitle: Artifactsand documented it as an intentionaltitle_too_shortexception./api/and/openapi.yamlmap to local source files instead of being treated as unfixable.src/pages/api.astroso the generated Scalar API reference has an H1 for SEO and accessibility checks.integrityattribute from the Scalar CDN script tag so the API reference is not blocked by an SRI mismatch./apitopbar Docs link into the left breadcrumb area between the Warp logo andAPI Reference.Validation
npm run buildpassed./api/page includes the Scalar API reference script without anintegrityattribute.SEO audit notes
Artifactsis now allowlisted as an intentionally short title because the Reference > CLI context disambiguates it and the page documents theoz artifactresource./api/is no longer categorized as unfixable solely because it is generated; the local shell lives insrc/pages/api.astro, while API content still comes fromdevelopers/agent-api-openapi.yaml.Conversation: https://app.warp.dev/conversation/f0fb6f31-765c-4849-9a21-2b068657e089
Run: https://oz.warp.dev/runs/019e2a6f-5f24-77ea-9dc1-02e0140a2756
This PR was generated with Oz.
Co-Authored-By: Oz oz-agent@warp.dev