docs: hand-steer related topics on the top agent-read pages - #249
Conversation
…ion paths The three most AI-read pages (Mintlify analytics 30d: x402-card-delegation spec 207 agent views, integrations/mcp 140, nevermined-x402 guide 115) get hand-picked related links pointing at the doors we want walked through: get-api-key, enroll-card, add-payments, quickstart. Automatic mode covers every other page; frontmatter overrides only where the traffic is.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
There was a problem hiding this comment.
Pull request overview
This PR aims to improve conversion/navigation by overriding Mintlify’s automatic “Related topics” on three high-traffic agent-read pages, adding hand-picked links into the agent onboarding and payments setup path.
Changes:
- Adds
relatedfrontmatter entries to three docs pages to guide readers toward key conversion steps (API key, enroll card, add payments, quickstart, register plan/agent).
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/specs/x402-card-delegation.mdx | Adds curated related links in frontmatter for the card-delegation spec page. |
| docs/integrations/mcp.mdx | Adds curated related links in frontmatter for the MCP integration page. |
| docs/development-guide/nevermined-x402.mdx | Adds curated related links in frontmatter for the x402 dev guide page. |
| related: | ||
| - Get a Nevermined API key: /docs/agents-guide/get-api-key | ||
| - Enroll a card and delegate a budget: /docs/agents-guide/enroll-card | ||
| - Add payments to your agent: /docs/agents-guide/add-payments | ||
| - Quickstart: /docs/getting-started/quickstart |
There was a problem hiding this comment.
Refuted, with evidence both ways: Mintlify's official docs document exactly this shorthand ('Mix internal pages, external links, and custom titles: - Set up auth: /deploy/authentication-setup' — mintlify.com/docs/organize/related-pages), and the PR's own preview deployment renders all four custom-titled links correctly: https://neverminedag-feat-related-steering.mintlify.site/docs/specs/x402-card-delegation (Related topics section at the bottom). No change needed.
| related: | ||
| - Get a Nevermined API key: /docs/agents-guide/get-api-key | ||
| - Add payments to your agent: /docs/agents-guide/add-payments | ||
| - Quickstart: /docs/getting-started/quickstart |
There was a problem hiding this comment.
Refuted, with evidence both ways: Mintlify's official docs document exactly this shorthand ('Mix internal pages, external links, and custom titles: - Set up auth: /deploy/authentication-setup' — mintlify.com/docs/organize/related-pages), and the PR's own preview deployment renders all four custom-titled links correctly: https://neverminedag-feat-related-steering.mintlify.site/docs/specs/x402-card-delegation (Related topics section at the bottom). No change needed.
| related: | ||
| - Get a Nevermined API key: /docs/agents-guide/get-api-key | ||
| - Add payments to your agent: /docs/agents-guide/add-payments | ||
| - Register a plan and agent: /docs/agents-guide/register-plan-and-agent |
There was a problem hiding this comment.
Refuted, with evidence both ways: Mintlify's official docs document exactly this shorthand ('Mix internal pages, external links, and custom titles: - Set up auth: /deploy/authentication-setup' — mintlify.com/docs/organize/related-pages), and the PR's own preview deployment renders all four custom-titled links correctly: https://neverminedag-feat-related-steering.mintlify.site/docs/specs/x402-card-delegation (Related topics section at the bottom). No change needed.
aaitor
left a comment
aaitor
left a comment
There was a problem hiding this comment.
First review. Low-risk content steering — adds a related: frontmatter list of curated next-steps to three high-traffic agent-read pages (x402, MCP, card-delegation spec). Approving; one thing to confirm in the inline comment.
Verification I ran
- All 11 link targets resolve on the branch:
agents-guide/{get-api-key,add-payments,register-plan-and-agent,enroll-card}andgetting-started/quickstartall exist as.mdx. No dead links. - The three
related:blocks are internally consistent (same path style, same key ordering) and each points at a sensible funnel from that page. - CI green (2/2 — Mintlify build + link check).
The only open question is whether related: is actually consumed (below).
| title: "Nevermined x402" | ||
| description: "Nevermined provides first-class support for the x402 payment protocol, enabling AI agents, APIs, and services to charge per-request using secure, locally-signed payment authorizations." | ||
| icon: "credit-card" | ||
| related: |
There was a problem hiding this comment.
MEDIUM — confirm something actually consumes the related: frontmatter, or this is inert. related isn't a native Mintlify frontmatter key (nav lives in docs.json; Mintlify link-rot won't validate these values), so unless a generator or component in this epic reads it, these three blocks render/emit nothing and the "steering" has no effect. If the consumer (llms.txt/related-topics injector) is a later PR in the epic, that's fine — this is just staging the data ahead of it; please link that PR/issue so it's tracked. If the consumer is expected to be Mintlify itself, it won't pick this up. No content change needed — just verify the wiring exists or is coming.
Related topics just went live (Automatic, 5). This overrides the three most agent-read pages (per Mintlify analytics, 30d: card-delegation spec 207 AI views, MCP integration 140, x402 dev guide 115) with hand-picked links toward the conversion path: get-api-key, enroll-card, add-payments, quickstart, register-plan-and-agent.
Rationale: these pages are where AI agents (93% of docs traffic) actually read; the related links are the cheapest possible nudge from reading the rail's spec to holding an API key. Every other page keeps automatic suggestions.
Three files, frontmatter only.
🤖 Generated with Claude Code