Skip to content

docs(overview): update Relay subheader#375

Merged
jmaier6 merged 1 commit into
mainfrom
docs/homepage-rewrite
Jul 23, 2026
Merged

docs(overview): update Relay subheader#375
jmaier6 merged 1 commit into
mainfrom
docs/homepage-rewrite

Conversation

@jmaier6

@jmaier6 jmaier6 commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • update the What is Relay page subheader to Enterprise-Grade Onchain Payments Infrastructure

Verification

  • confirmed the PR changes one line in what-is-relay.mdx
  • verified the commit's GPG signature

@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown

Claude finished @jmaier6's task in 1m 53s —— View job


Code review: rewrite What is Relay page

  • Read the PR diff
  • Read the full changed file
  • Check against repo style guide (AGENTS.md)
  • Post review

Nice rewrite overall — the use-case → benefits → stack flow reads much more cleanly than the old page, the voice matches the guide (product-as-subject, "you" for reader actions, "we/our" used sparingly), paragraphs stay short, and terminology is actually more compliant than before (crosschaincross-chain, onchain one word). Links are root-relative per §2.6, and I confirmed the targets resolve: /solutions/commerce-and-payments, /use-cases/*, /security/compliance, /references/api/api_core_concepts/fees, /references/api/overview, and /references/protocol/overview all exist; /resources/enterprise resolves via a redirect in docs.json.

A few things to address before merge:


🔴 Blocker — TODO comment + unverified stats shipping in the page

what-is-relay.mdx:25

{/* TODO(relay): confirm canonical hero stats before publish. The site currently shows conflicting figures — volume as $5B vs $20B, transactions as 50M vs 100M, chains as 75 / 85 / "100s". This page uses the solutions-page set; align every page to one source of truth. */}

This TODO shouldn't ship. More importantly, it flags that the hero numbers are not yet confirmed — and this PR doubles two of them versus what was on the page before:

Stat Previous page This PR
Volume $5B+ $20B+
Transactions 50M 100M+

what-is-relay.mdx:17-21. The style guide leans hard on "concrete numbers when available" (§2.4), which cuts both ways — publishing figures the author has flagged as conflicting risks putting an inaccurate claim on the single most-visited page. Please pin these to a canonical source and remove the TODO before merging (or hold the numeric jump until confirmed). The PR description says stats were "refreshed" but doesn't cite where $20B/100M come from — worth calling out in the PR.

Fix this →


🟡 Minor — description frontmatter style

what-is-relay.mdx:3description: "Enterprise-Grade Onchain Payments Infrastructure" is a Title-Cased noun phrase. §2.1 asks for a one-sentence summary that "starts with a verb when possible" and sentence-style casing. Not a hard rule for this root page (it's outside the §1.1 path table), and it does render as the subtitle you wanted, but consider something verb-led like "Move any token or trigger any action across 85+ chains in a single transaction."

🟡 Minor — verify the enterprise CTA target

what-is-relay.mdx:86[Contact us](/resources/enterprise) works, but the docs.json redirect sends /resources/enterprise/references/api/api-keys. Landing a "Contact us about dedicated support, custom SLAs, and priority routing" CTA on the API keys page seems off. Confirm that's the intended destination, or point it at a real contact/enterprise page.

⚪ Nit — < in a Card title

what-is-relay.mdx:14title="< 3s Settlement". MDX handles a literal < inside a quoted attribute fine, so this should render, but worth a quick glance in the local preview to be sure it isn't escaped oddly.


Scope note: what-is-relay.mdx isn't in the §1.1 path→profile table, so §3 profile rules are advisory here; I reviewed against the §2 global rules and §5 terminology, which it otherwise follows well.

@mintlify

mintlify Bot commented Jul 23, 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 23, 2026, 6:49 PM

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

@jmaier6
jmaier6 force-pushed the docs/homepage-rewrite branch from d484f81 to e05ba76 Compare July 23, 2026 18:51
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown

Claude finished @jmaier6's task in 1m 50s —— View job


Code review: rewrite What is Relay page

  • Read the current PR diff (post-synchronize)
  • Read the full changed file
  • Check against repo style guide (AGENTS.md)
  • Verify link/redirect targets
  • Post review

The rewrite reads well — the use-case → benefits → stack flow is a clear improvement, voice matches the guide (product-as-subject for definitions, "you" for reader actions, "we/our" sparingly), paragraphs stay within §2.10, and terminology is compliant (cross-chain hyphenated, onchain one word, chain/team names canonical). All internal links are root-relative per §2.6, and I confirmed every target resolves: /solutions/commerce-and-payments, /use-cases/bridging, /use-cases/cross-chain-swaps, /use-cases/calling, /security/compliance, /references/api/api_core_concepts/fees, /references/api/overview, /references/protocol/overview, and /references/api/quickstart all exist.

Note: the diff is unchanged since the earlier review on this PR (still one commit, e05ba76). The blocker and minors below are unresolved and still need to be addressed before merge.


🔴 Blocker — TODO comment + unverified hero stats shipping in the page

what-is-relay.mdx:25

{/* TODO(relay): confirm canonical hero stats before publish. The site currently shows conflicting figures — volume as $5B vs $20B, transactions as 50M vs 100M, chains as 75 / 85 / "100s". This page uses the solutions-page set; align every page to one source of truth. */}

This TODO should not ship on the most-visited page in the docs, and — more importantly — it flags that the hero numbers are not yet confirmed. This PR doubles two of them versus the previous page:

Stat Previous page This PR
Volume $5B+ $20B+
Transactions 50M 100M+

what-is-relay.mdx:17-21. §2.4 leans on "concrete numbers when available," which cuts both ways — publishing figures the author has flagged as conflicting risks putting an inaccurate claim front-and-center. Please pin these to a canonical source and remove the TODO before merging (or hold the numeric jump until confirmed), and cite the source for $20B/100M in the PR description.

While confirming those, also verify the reliability claim at what-is-relay.mdx:54: it changed from the old page's "99.9% uptime" to "99.9%+ transaction success". Those are different guarantees — make sure the one you keep is the one you can stand behind.

Fix this →


🟡 Minor — enterprise CTA points at the wrong page

what-is-relay.mdx:86[Contact us](/resources/enterprise). I confirmed in docs.json:413-416 that /resources/enterprise redirects to /references/api/api-keys. A "Contact us about dedicated support, custom SLAs, and priority routing" CTA landing on the API keys reference page is almost certainly not intended. Point it at a real contact/enterprise destination (or fix the redirect).

Fix this →

🟡 Minor — description frontmatter style

what-is-relay.mdx:3description: "Enterprise-Grade Onchain Payments Infrastructure" is a Title-Cased noun phrase. §2.1 asks for a one-sentence summary that "starts with a verb when possible." This page is outside the §1.1 path→profile table so §3 is advisory, but the §2 global rule still applies — consider a verb-led, sentence-case line like "Move any token or trigger any action across 85+ chains in a single transaction." (Note: whatever you choose renders as the page subtitle, so keep it reader-facing.)

⚪ Nit — literal < in a Card title

what-is-relay.mdx:14title="< 3s Settlement". MDX handles a literal < inside a quoted attribute fine, but it's worth a glance in the Mintlify preview to confirm it isn't escaped oddly.

⚪ Nit — multichain vs cross-chain

The page uses cross-chain throughout but keeps multichain in one spot (what-is-relay.mdx:42, "Collapse multichain complexity"). §5 doesn't define multichain, so this isn't a violation, but picking one for consistency reads cleaner.


Scope note: what-is-relay.mdx isn't in the §1.1 path→profile table, so §3 profile rules are advisory here. I reviewed against the §2 global rules and §5 terminology, which the page otherwise follows well. This is review feedback only — no changes were committed.
• Branch: docs/homepage-rewrite

@jmaier6
jmaier6 force-pushed the docs/homepage-rewrite branch from e05ba76 to 795d600 Compare July 23, 2026 18:58
@jmaier6 jmaier6 changed the title docs(overview): rewrite What is Relay page docs(overview): update Relay subheader Jul 23, 2026
@github-actions

github-actions Bot commented Jul 23, 2026

Copy link
Copy Markdown

Claude finished @jmaier6's task in 2m 2s —— View job


Code review: rewrite What is Relay page

  • Read the PR diff (origin/main...HEAD)
  • Read the full changed file
  • Check against repo style guide (AGENTS.md)
  • Verify link / redirect targets
  • Post review

Heads up — the earlier reviews on this PR are stale. They evaluated a large rewrite (TODO comment, $20B/100M hero stats, /resources/enterprise CTA, 99.9%+ transaction success). None of that is in the branch anymore. The current diff against origin/main is a single-line frontmatter change, and the body of the page (the "Relay Stack" rewrite) is already on main via 57126a1 docs(drift): draft from internal source (#373). So the previous 🔴 blocker and 🟡 minors no longer apply to what's being merged here.

The actual change:

-description: "The fastest and cheapest way to bridge & transact across chains"
+description: "Enterprise-Grade Onchain Payments Infrastructure"

This is a clean, low-risk subtitle repositioning. The author confirmed it renders correctly as the page subtitle, and onchain is one word per §5. ✅ No blockers.


🟡 Minor — description style vs §2.1

what-is-relay.mdx:3 — §2.1 asks the description to be "a one-sentence summary, starts with a verb when possible" in sentence case. "Enterprise-Grade Onchain Payments Infrastructure" is a Title-Cased noun phrase, so it diverges from that global rule. Two mitigating factors: (1) what-is-relay.mdx is outside the §1.1 path→profile table, so profile rules are advisory here; (2) the previous value was also a non-verb noun phrase, so this isn't a regression — it's a lateral swap to Title Case for a hero tagline.

If you want to align with §2.1 while keeping it reader-facing as the subtitle, something verb-led like "Move any token or trigger any action across 85+ chains in a single transaction." would fit. Otherwise this is fine to ship as an intentional positioning choice.

Fix this →


⚪ Out of scope (pre-existing on main, not introduced by this PR)

Not blocking this PR, but while reading the page I noticed a couple of §5 / consistency items worth a follow-up on what-is-relay.mdx:

  • crosschaincross-chain at lines 66 and 93 — §5 requires the hyphenated cross-chain. (The Cards at the top already use Cross-chain correctly.)
  • Chain-count inconsistency — the page mixes 100s of chains (L6), 85 chains (L11), 85+ networks (L6, L82), and 75+ chains (L60). Worth normalizing to one figure.

These live in the already-merged body, so they're a separate cleanup, not a change request on this diff.


Verdict: ✅ The one-line subtitle change is safe to merge. The description-casing note is a minor, advisory style preference; the terminology items are pre-existing and out of scope for this PR.

Scope note: what-is-relay.mdx isn't in the §1.1 path→profile table, so §3 profile rules are advisory. Reviewed against §2 global rules and §5 terminology. This is review feedback only — no changes committed.
• Branch: docs/homepage-rewrite

@jmaier6
jmaier6 merged commit 67dd3b1 into main Jul 23, 2026
4 checks passed
@jmaier6
jmaier6 deleted the docs/homepage-rewrite branch July 23, 2026 18:59
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.

2 participants