Add new API key guides and improve existing documentation#985
Open
martyndavies wants to merge 2 commits intomainfrom
Open
Add new API key guides and improve existing documentation#985martyndavies wants to merge 2 commits intomainfrom
martyndavies wants to merge 2 commits intomainfrom
Conversation
New pages: - When to Use API Keys: API keys vs JWT/OAuth decision guide with comparison table, decision checklist, retrievable vs irretrievable keys, HTTPS and client-side warnings. - API Key Best Practices: 8 practices mapped to Zuplo features covering format, checksum, leak detection, rotation, caching, retrievable keys, masked display, and creation dates. - Build Self-Serve API Key Management: end-to-end implementation guide for embedding key management into your own product using the Zuplo Developer API. Includes architecture, Express.js backend example, security with tags, and integration options. Improved existing pages: - api-key-management.mdx: trimmed from 155 to 75 lines, refocused as a landing page that routes to dedicated pages for depth. - concepts/api-keys.md: expanded "How validation works" with the explicit 4-step flow and cacheTtlSeconds guidance. - api-key-end-users.mdx: expanded Developer API section. - api-key-react-component.mdx: explained backend architecture. - api-key-api.mdx: added callout linking to self-serve guide. - sidebar.ts: added all three new pages to API Keys category. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
The React component is being updated, so remove references to it as a "drop-in" option from the new pages until the new version is ready. Removes the tip callout, integration table row, and Next Steps link from the self-serve guide, and the mention from the best practices page. Co-Authored-By: Claude Opus 4.6 (1M context) <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.
New pages:
Improved existing pages: