Skip to content

📝 docs: fix API key guide and landing FAQ#844

Merged
yripper merged 5 commits intomainfrom
docs/fix-typos
Apr 14, 2026
Merged

📝 docs: fix API key guide and landing FAQ#844
yripper merged 5 commits intomainfrom
docs/fix-typos

Conversation

@MattPoblete
Copy link
Copy Markdown
Collaborator

Summary

Changes

Docs

  • New page: api-integration-guide/guides-and-tutorials/getting-api-key.md — step-by-step API key creation guide
  • api-integration-guide/api.md — expanded Generate API Key section, linked to new guide, fixed broken prereqs link
  • guides-and-tutorials/beginner-guide.md — replaced Discord contact prompt with link to new guide
  • SUMMARY.md — added "Getting Your API Key" entry under Guides and Tutorials
  • guides-and-tutorials/privy-server-wallets.md — new Privy server wallets integration guide

Landing

  • apps/landing/src/components/globals/Frequently/index.tsx — removed incorrect "example of fees" FAQ entry, replaced with "How do revenue shares work?"

Test plan

  • Verify new API key guide page renders correctly in GitBook
  • Verify all internal links in api.md and beginner-guide.md resolve to the new page
  • Verify landing page FAQ no longer shows the "example of fees" text
  • Confirm SUMMARY.md navigation includes "Getting Your API Key"

Copilot AI review requested due to automatic review settings April 13, 2026 14:59
@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 13, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
defindex-dapp Ready Ready Preview, Comment Apr 13, 2026 3:01pm
defindex-landing Ready Ready Preview, Comment Apr 13, 2026 3:01pm
defindex-rust-docs Ready Ready Preview, Comment Apr 13, 2026 3:01pm

Request Review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates developer-facing documentation to reflect the new self-serve API key flow, adds a Privy server wallets integration guide, and corrects the landing page FAQ content per linked issues.

Changes:

  • Added a dedicated “Getting Your API Key” guide and updated existing docs to link to it.
  • Added a “Privy Server Wallets” integration guide and included it in docs navigation.
  • Adjusted landing page FAQ copy to remove the “example of fees” content.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
apps/landing/src/components/globals/Frequently/index.tsx Removes the detailed “example of fees” revenue-share example text from the FAQ entry.
apps/docs/SUMMARY.md Adds navigation entries for “Getting Your API Key” and “Privy Server Wallets”.
apps/docs/api-integration-guide/guides-and-tutorials/privy-server-wallets.md New guide describing Privy server wallets integration and linking to a reference repo.
apps/docs/api-integration-guide/guides-and-tutorials/getting-api-key.md New self-service API key creation guide (register → login → create key) with usage notes.
apps/docs/api-integration-guide/guides-and-tutorials/beginner-guide.md Replaces “contact the team” guidance with links/instructions for the self-serve API key + refresh flow.
apps/docs/api-integration-guide/api.md Updates “Generate your API Key” section to link to the new guide and improves steps/wording.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +71 to +75
## Prerequisites

* [Privy](https://privy.io) app with TEE enabled and an Authorization Key configured
* Defindex API key — request access on [Discord](https://discord.gg/e2qAhJCBmx)

Copy link

Copilot AI Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This guide still says to “request access on Discord” for a DeFindex API key, which contradicts the new self‑service API key flow introduced in this PR. Update this prerequisite to point to the new “Getting Your API Key” guide (and only mention Discord for support, if needed).

Copilot uses AI. Check for mistakes.
@yripper yripper merged commit 1900887 into main Apr 14, 2026
10 checks passed
@yripper yripper deleted the docs/fix-typos branch April 14, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Product crosschain Privy [Docs] Fix broken API key documentation link [Docs] fix FAQs Split shares

3 participants