Skip to content

docs: rewrite Universal Usernames as a why page and a three-step setup guide - #22

Merged
HAPPYS1NGH merged 7 commits into
mainfrom
docs/universal-usernames-minimal
Nov 16, 2026
Merged

HAPPYS1NGH merged 7 commits into
mainfrom
docs/universal-usernames-minimal

Conversation

@HAPPYS1NGH

Copy link
Copy Markdown
Collaborator

Changes

  • Guide opens with the three steps (build endpoint, save it, set resolver) instead of prerequisites, so the setup reads as quick and simple.
  • Request shown as GET {base URL}/{username} with a happy example, so the URL shape is obvious.
  • Usernames, text records and addresses formats moved under Step 1, so devs see them while building the endpoint.
  • Added ENSIP-15 username rules (verified with viem normalize), including underscores only at the start and a toEnsLabel helper.
  • Text records table covers ENSIP-5 and ENSIP-18 keys plus custom reverse-domain keys like com.brand.tier.
  • Address keys explained (2147483648 default EVM, 0x80000000 | chainId, SLIP-44), so coin types aren't magic numbers.
  • Simpler Next.js example endpoint with bearer token check that fails closed when the token is unset.
  • App flow trimmed to save, test and set resolver (transfer records, set resolver, enable), with CORS and existing-subname warnings.
  • Dropped gateway internals, the curl test section and pros/cons; kept security practices and a short FAQ.
  • Overview next steps now point to the setup guide and the App instead of "Talk to us".

Notes

  • mint broken-links passes.
  • App flow checked against the webapp hybrid-resolver-setup copy; address fallback, 60s cache and 401/403 handling checked against the ccip-gateway source.
  • Follow-up: add App screenshots to Step 2.

🤖 Generated with Claude Code

HAPPYS1NGH and others added 7 commits November 13, 2026 03:33
Cover onchain naming services alongside apps with their own database,
since both build the same HTTP endpoint. Detailed product education
moves to the landing page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Prerequisites, build the adapter (schema, address keys, simple example),
save it in the App, set the resolver. Adds security practices, pros and
cons and an FAQ. Drops gateway internals and adapter testing.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Open with the three steps instead of prerequisites, move username,
text record and address formats under the endpoint step, document
custom text keys, drop pros and cons, and point the overview's next
steps at the setup guide and the App.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Show the request as {base URL}/{username} without a /ens path, add
ENSIP-18 profile keys and a custom key to the text record table.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@HAPPYS1NGH
HAPPYS1NGH merged commit 94514d9 into main Nov 16, 2026
2 checks passed
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.

1 participant