Skip to content

Update docs for developer dashboard #369

Merged
ted-palmer merged 8 commits into
mainfrom
ted/int2-277-update-docs-for-dev-dashboard-mvp
Jul 17, 2026
Merged

Update docs for developer dashboard #369
ted-palmer merged 8 commits into
mainfrom
ted/int2-277-update-docs-for-dev-dashboard-mvp

Conversation

@ted-palmer

@ted-palmer ted-palmer commented Jul 16, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@ted-palmer
ted-palmer requested review from n-xlkt and pedromcunha July 16, 2026 21:14
@github-actions

This comment was marked as outdated.

Sign in to view
@mintlify

mintlify Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
unevenlabs 🟢 Ready View Preview Jul 16, 2026, 9:15 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

pedromcunha
pedromcunha previously approved these changes Jul 17, 2026
View reviewed changes
@pedromcunha

pedromcunha commented Jul 17, 2026

Copy link
Copy Markdown
Member

@ted-palmer can we remove .scratch/int2-315-prompt.md

n-xlkt
n-xlkt previously approved these changes Jul 17, 2026
View reviewed changes

@n-xlkt n-xlkt left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm

@ted-palmer
ted-palmer dismissed stale reviews from n-xlkt and pedromcunha via 47ea0a9 July 17, 2026 13:03
@github-actions

github-actions Bot commented Jul 17, 2026 •
edited
Loading

Copy link
Copy Markdown

Claude finished @ted-palmer's task in 1m 26s —— View job

PR Review: Update docs for developer dashboard

  • Gather context (diff vs origin/main, read changed files)
  • Review against repo style guide (AGENTS.md)
  • Post review feedback

This is a clean, well-scoped update that swaps the old "Enterprise Partner + reach out to link a wallet" model for the self-serve dashboard model. The nav entry, redirects, the #enterprise-link injection in script.js/style.css, and the deleted resources/enterprise.mdx are all removed consistently, with /resources/partnerships and /resources/enterprise both redirecting to /references/api/api-keys. The api-keys.mdx rewrite reads well and the code blocks are now correctly tagged typescript. No doc pages link to the removed #how-to-get-an-api-key anchor anymore.

✅ .scratch/int2-315-prompt.md is now gone — the file flagged in the earlier review (and by @pedromcunha) is no longer tracked. Good.

A couple of small things remain:

🟡 1. Terminology inconsistency: "linked funding address" vs. "Fee Sponsorship Wallet"

features/fast-fill.mdx:15 and features/fee-sponsorship.mdx:21 now standardize on "Fee Sponsorship Wallet", but features/gasless-execution.mdx:16 still uses the old wording — twice, including in the cross-link to the fee-sponsorship page:

To use gasless execution you'll need an API key with a linked funding address… then see Fee Sponsorship for details on linking a funding address…

A reader following that link lands on a page that calls the same thing a "Fee Sponsorship Wallet." Per the terminology intent in AGENTS.md §5, pick one canonical term and use it everywhere. Worth confirming what the dashboard UI actually labels it so the docs match the product.

Fix this →

🟢 2. Nit: mixed heading capitalization in api-keys.mdx

The rewrite lowercased some headings to sentence case (Creating an API key, Tracking requests, Default Rate Limits (no API key), HTTP requests, SDK usage) while leaving neighbors in title case (API key Rate Limits, How to Use an API key, Keeping Your API key Secure). Not a style-guide violation, but the page now mixes both. Sentence case reads most Stripe-adjacent per §2.4 — worth normalizing to one convention.

Fix this →

🟢 3. Nit (out of scope): stale example anchor in AGENTS.md

AGENTS.md §2.6 (line 93) still uses /references/api/api-keys#how-to-get-an-api-key as its illustrative anchor-link example, but this PR removes that heading. It's only an example so nothing renders broken — could swap it for a surviving anchor like #creating-an-api-key in a future cleanup.

Overall LGTM — the must-fix scratch file is already handled, and items 1–3 are polish. I'll leave the fixes to you unless you'd like me to apply them; just say the word.
• Branch: ted/int2-277-update-docs-for-dev-dashboard-mvp

@pedromcunha
pedromcunha self-requested a review July 17, 2026 13:15
@ted-palmer
ted-palmer merged commit d85dd7d into main Jul 17, 2026
4 checks passed
@ted-palmer
ted-palmer deleted the ted/int2-277-update-docs-for-dev-dashboard-mvp branch July 17, 2026 13:16
@n-xlkt n-xlkt mentioned this pull request Jul 17, 2026
Merged
n-xlkt added a commit that referenced this pull request Jul 21, 2026
@n-xlkt
docs(api-keys): revise rate limit copy
af1dc39 
## What Changed

Reframes the API key rate-limit docs so a key reads as self-minted in the [Relay Dashboard](https://dashboard.relay.link), with the default limits applying to those keys and higher limits available on request through the Dashboard support widget. Renames the two rate-limit sections on `references/api/api-keys.mdx` to **Default Rate Limits** and **Elevated Rate Limits** (limit values unchanged), and drops the same "raise your rate limits" / "available to anyone" framing from the quickstart, the shared `GetAnApiKey` snippet, and the websockets guide.

## Why

The copy implied any API key inherently grants higher limits, and that the API is usable unauthenticated at a baseline rate. In reality a newly self-minted key starts on the default limits — the same numbers previously labeled "no API key" — and higher limits are granted on request. Pedro flagged this after the developer-dashboard docs shipped in #369.

## Impact

Documentation only — no API or SDK behavior changes. Anchor slugs on the API keys page change (`#default-rate-limits-no-api-key` → `#default-rate-limits`, `#api-key-rate-limits` → `#elevated-rate-limits`); a repo-wide check found no internal links to the old anchors.

## Related Context

- Refs: INT2-929
- Refs: https://relayprotocol.slack.com/archives/C04EBEGJV2M/p1784297558289219
- Prior PR: #369 (developer dashboard docs)

## Testing

Static review plus a `grep` sweep confirming no residual "to raise your rate limits" / "available for anyone" / "(no API key)" / "generally not required" phrasing remains. The Mintlify CLI isn't installed in this environment, so the rendered page was **not** previewed live; MDX structure (tables, `<Tip>`/`<Warning>`/`<Callout>` tags, frontmatter) was verified by inspection.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pedromcunha pedromcunha pedromcunha approved these changes
@n-xlkt n-xlkt n-xlkt left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ted-palmer @pedromcunha @n-xlkt