improve agentic readiness of docs - #425
Merged
Merged
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
shirgoldbird
commented
Sep 10, 2026
shirgoldbird
added a commit
that referenced
this pull request
Sep 10, 2026
…e spec" This reverts commit 0c38c9c. PR #425 (docs/agentic-readiness-fixes) already adds these redirects, along with /openapi.json and /api/openapi.json, and does it properly: it also drops api-reference/openapi.json from .mintignore and declares api.openapi/api.asyncapi in docs.json, so the JSON paths serve real JSON rather than redirecting to YAML. Keeping both would duplicate the entries and conflict on merge. All docs.json redirect changes belong in #425; this branch stays scoped to the spec itself. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
59 of 152 content pages had no frontmatter `description`, so Mintlify emitted no meta description and no og:description for them at all. Three more were under the 50 characters that search and answer engines want, including the about and privacy pages added earlier on this branch. Every page now carries a description between 50 and 200 characters, written per CLAUDE.md: action-oriented, and specific enough to the page that it could not be pasted onto a sibling. Reference pages describe what the endpoint does; guides describe what the reader will be able to do. Also trims the one description that ran over 200 characters (list-translation-memories) and moves the cross-reference it contained into the page body, where it renders as a link. Verified: all 152 pages parse and sit in the 50-200 range. `mint broken-links` surfaces nothing new; its only non-pipeline/drafts finding is the pre-existing /docs/resources/contact-and-support link in privacy.mdx, which needs the slug decision noted on the PR. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
The new pages are contact.mdx and privacy.mdx, but the redirects, the JSON-LD contactPoint URL, and a link in privacy.mdx all pointed at /docs/resources/contact-and-support and /docs/resources/privacy-and-data-security, which do not exist. So /contact, /contact-us, /support and /privacy all landed on a 404, which is exactly what the trust-anchor checks probe, and the body link was the repo's only broken link outside pipeline/drafts. Fixed by pointing all six references at the short slugs rather than renaming the pages, keeping /docs/resources/contact and /docs/resources/privacy as the canonical URLs. Verified: every /contact, /contact-us, /support and /privacy redirect now resolves to a real page, the JSON-LD still parses, and `mint broken-links` reports nothing outside pipeline/drafts. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
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
1 participant
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.
https://is-agentic.com/scan/developers.deepl.com