feat(docs): publish the API description where machines look for it - #12595
Open
jd wants to merge 3 commits into
Open
feat(docs): publish the API description where machines look for it#12595jd wants to merge 3 commits into
jd wants to merge 3 commits into
Conversation
This was referenced Aug 28, 2026
Member
Author
|
This pull request is part of a Mergify stack:
|
This was referenced Aug 28, 2026
Contributor
Merge Protections🔴 2 of 7 protections blocking · waiting on 👀 reviews
🔴 👀 Review RequirementsWaiting for
This rule is failing.
🔴 🔎 ReviewsWaiting for
This rule is failing.
Show 5 satisfied protections🟢 ⛓️ Depends-On RequirementsRequirement based on the presence of
🟢 🤖 Continuous Integration
🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR description
🟢 🚦 Auto-queueWhen all merge protections are satisfied, this pull request will be queued automatically. |
There was a problem hiding this comment.
Pull request overview
This PR improves machine discoverability of the Mergify OpenAPI spec and related developer-entry signals by exposing conventional URLs and metadata that tooling and crawlers expect.
Changes:
- Adds an
/openapi.jsonendpoint that serves the existingpublic/api-schemas.jsonOpenAPI document. - Adds
<link rel="service-desc">(OpenAPI) and an alternate link forllms.txtto the global page head. - Updates
robots.txtto include aSitemap:directive and adds/developersredirects to the API reference.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/pages/openapi.json.ts | New endpoint serving the OpenAPI document at the conventional discovery path. |
| src/components/HeadCommon.astro | Adds machine-readable <link> entry points for OpenAPI discovery and llms.txt. |
| public/robots.txt | Adds an explicit sitemap directive for crawlers. |
| public/_redirects | Redirects /developers to the API reference. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
jd
force-pushed
the
devs/jd/agentic-readiness/publish-api-desc-machines-look--1b625f96
branch
from
August 28, 2026 14:37
d8b4503 to
c8af4a6
Compare
Member
Author
Revision history
|
`getOgImageUrl` strips the leading and trailing slashes off the pathname to build the image filename. For the homepage that pathname is `/`, so stripping left an empty string and the lookup missed — every docs page had an OpenGraph image and the homepage shipped `<meta property="og:image">` with no content. The homepage's collection id is `index`, which is what `getStaticPaths` names its image, so fall back to that when the slug comes out empty. Covered by a regression test that fails against the old expression. The generated-image set comes from the content collection and needs the Astro build pipeline, so the test stubs it and exercises the derivation, which is the half that was wrong. Change-Id: Ifb9a23ea2caa20d28489a4f21363d85ed5e3342c
Docset cards rendered their title as `h4`. Almost every grid sits directly under an `##`, so the outline jumped h2 to h4 — including on the homepage, whose whole body is the "Products" grid. Screen readers and anything parsing the document outline read that as a missing level. Default the card heading to `h3` and make it a prop, because one grid does belong at h4: the "Components" grid in `ci-insights.mdx` is nested under an `### Components`, where h3 would make the cards siblings of their own section heading instead of children. Change-Id: Ie01f4c2b03f1f2b7f798ae89b056135a5b00800e
The Mergify OpenAPI 3.1 document is already deployed — it is what the API Reference pages are generated from — but only at `/api-schemas.json`, a filename that exists nowhere outside this repository. Every OpenAPI client, SDK generator and crawler probes `/openapi.json`, so nothing finds it and the docs read as a site with no API at all. Serve the same bytes at `/openapi.json`. The route does not transform the document: the spec is synced from the engine repository, and two spellings of it that could disagree would be worse than one obscure path. Alongside it, three other entry points that were undiscoverable: - `<link rel="service-desc">` in every page head, the IANA relation for "the description of this site's API" (RFC 8631), plus one for `llms.txt`. - `robots.txt` had no `Sitemap:` line, so crawlers had to guess `sitemap-index.xml` rather than be told. - `/developers` is the path people and tools guess for a developer portal and was a 404; it now redirects to the API reference. Change-Id: I1b625f960363c8427d5282c052fee74111bf07fa
jd
force-pushed
the
devs/jd/agentic-readiness/publish-api-desc-machines-look--1b625f96
branch
from
August 28, 2026 15:09
c8af4a6 to
eb8bd0c
Compare
Base automatically changed from
devs/jd/agentic-readiness/stop-docset-grids-skipping-heading-level--e01f4c2b
to
main
September 3, 2026 07:47
remyduthu
approved these changes
Sep 3, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Mergify OpenAPI 3.1 document is already deployed — it is what the API
Reference pages are generated from — but only at
/api-schemas.json, afilename that exists nowhere outside this repository. Every OpenAPI client,
SDK generator and crawler probes
/openapi.json, so nothing finds it and thedocs read as a site with no API at all.
Serve the same bytes at
/openapi.json. The route does not transform thedocument: the spec is synced from the engine repository, and two spellings of
it that could disagree would be worse than one obscure path.
Alongside it, three other entry points that were undiscoverable:
<link rel="service-desc">in every page head, the IANA relation for "thedescription of this site's API" (RFC 8631), plus one for
llms.txt.robots.txthad noSitemap:line, so crawlers had to guesssitemap-index.xmlrather than be told./developersis the path people and tools guess for a developer portal andwas a 404; it now redirects to the API reference.
Depends-On: #12594