docs(use-cases): add Use Cases section with paid-API-key pattern#177
Draft
r-marques wants to merge 1 commit into
Draft
docs(use-cases): add Use Cases section with paid-API-key pattern#177r-marques wants to merge 1 commit into
r-marques wants to merge 1 commit into
Conversation
New top-level Use Cases group at the top of the Guides tab, with four pages framing productized integration patterns rather than feature tours: - overview.mdx — landing, cards-list of all use cases - monetize-paid-apis-for-agents.mdx — thin hub for the Exa-style vend-the-key pattern; cross-links to solutions/api-providers.mdx for the technical deep-dive instead of duplicating it - agent-discoverability.mdx — net-new content. The llms.txt + nevermined.md convention with a full copy-paste template lifted from the web-search-paid-api-ts tutorial - case-study-exa.mdx — short case study of Exa's live integration Second of three PRs landing nevermined-io/nvm-monorepo#1684: - tutorial: nevermined-io/tutorials#51 (draft, pending smoke-test) - docs (this PR) - multi-agent validation findings (PR-C) A follow-up issue will be filed to fix the verify→provision→settle ordering on solutions/api-providers.mdx, which currently shows the unsafe ordering in code samples. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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.
Summary
New top-level Use Cases group at the top of the Guides tab in
docs.json, with four new pages framing productized integration patterns rather than feature tours.The new section's job is to answer "is this the right shape for what I'm building?" before a reader dives into the technical Solutions pages. Per discussion with @r-marques on nevermined-io/nvm-monorepo#1684, this PR is a light-layer addition — the hub page cross-links into
solutions/api-providers.mdxfor the implementation deep-dive rather than duplicating it.Second of three PRs landing nevermined-io/nvm-monorepo#1684:
nevermined-io/tutorials#51, draft, pending smoke-test against sandbox)agent-discoverability.mdxChanges
docs.json"Use Cases"group at top of the Guides tab (above Learn); two redirects for/docs/use-casesand/docs/use-cases/docs/use-cases/overview.mdxdocs/use-cases/monetize-paid-apis-for-agents.mdxsolutions/api-providers.mdx, the tutorial, the case study, and Exa's live integration.docs/use-cases/agent-discoverability.mdxllms.txt+nevermined.mdconvention, fields to advertise, complete copy-paste templates (lifted from the tutorial), hosting guidance, a 3-step "test before agents see it" checklist, and a "Known agent rakes" placeholder that PR-C will populate.docs/use-cases/case-study-exa.mdxOut of scope
solutions/api-providers.mdx. The page's code samples (TS lines 78-80, Python lines 141-155, HTTP pseudo-code) show the unsafe ordering that PR-A's code review caught. Will be filed as a separate issue on nvm-monorepo after this merges, per @r-marques.agent-discoverability.mdxis a placeholder until then.Test plan
mintlify broken-linksclean (verified locally)mintlify a11yclean on the new MDX files (site-wide colour-contrast issues are pre-existing, unrelated){{PLACEHOLDER}}strings inside MDX paragraphs are wrapped in backticks so MDX doesn't try to parse them as JSX expressions; placeholders inside code fences are literalmintlify devpreview (left for reviewer)Notes for reviewers
monetize-paid-apis-for-agents.mdx) is deliberately thin. If it feels like it's covering ground thatsolutions/api-providers.mdxalready covers, that's a real concern to flag — happy to slim it further or restructure.agent-discoverability.mdxuses a four-backtick code fence to wrap a markdown template that itself contains three-backtick code fences. If that renders weirdly in your local preview, let me know.🤖 Generated with Claude Code