Skip to content

docs(drift): draft from internal source - #412

Open
pedromcunha wants to merge 2 commits into
mainfrom
docs-drift/src-260d4a1e33-5179282
Open

docs(drift): draft from internal source#412
pedromcunha wants to merge 2 commits into
mainfrom
docs-drift/src-260d4a1e33-5179282

Conversation

@pedromcunha

Copy link
Copy Markdown
Member

Drafted from an internal source repo, requested by @matirelay.

This PR was auto-generated by the reusable-docs-draft-pr workflow from a Claude-drafted update in the source repo. It is opened as a draft — please review, edit as needed, and mark ready for review before merging.

Review checklist

  • Content matches the behavior shipped in the source PR
  • No internal-only details (service names, file paths, unreleased names, security internals) leaked into the draft
  • Conforms to CLAUDE.md style rules
  • Cross-references and internal links resolve
  • Any Needs human input items from the source comment are addressed

Generated by reusable-docs-draft-pr.yml in relayprotocol/agents-config.

Requested by @matirelay via /publish-docs-pr
@mintlify

mintlify Bot commented Aug 13, 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 Aug 13, 2026, 5:51 PM

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

@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown

Claude encountered an error after 3m 18s —— View job


Code review — PR #412

  • Gather context (diff, file, related pages)
  • Analyze change against AGENTS.md style rules
  • Check for stale cross-references to the removed chain
  • Post review

The diff is a single-row deletion (ancient8 / 888888888) from the depository address table. It's harmless and directionally right — but it's maintenance on a page readers can't reach.


1. The edited file is orphaned — this change has no user-visible effect

references/protocol/depository/addresses.mdx is not in the docs.json navigation, and docs.json:508-509 redirects its URL away:

{ "source": "/references/protocol/depository/addresses",
  "destination": "/references/protocol/addresses" }

Since #379 (d654ef0) the canonical page is references/protocol/addresses.mdx, which renders the same four columns live from the Chains API via <Depositories /> (snippets/Depositories.mdx), filtered on protocol.v2.depository and sorted by chain.id — the same sort key the static table used. That page even says so in prose (references/protocol/addresses.mdx:29):

The list below is fetched live from the Chains API and stays in sync as new chains are added.

So ancient8 already dropped off the page readers actually see, the moment the API stopped returning it. All four .mdx files under references/protocol/depository/ are in this state — orphaned leftovers from the #379 restructure, present in docs.json only as redirect sources:

Orphan Redirects to
depository/addresses.mdx /references/protocol/addresses
depository/contracts/Evm-Relay-Depository.mdx /references/protocol/contracts/evm-depository
depository/contracts/Solana-Relay-Depository.mdx /references/protocol/contracts/solana-depository
depository/guides/integrating.mdx /references/protocol/guides/for-apps

Suggestion: rather than hand-maintaining the snapshot, delete the orphaned .mdx files. Keep the PDFs in that folder — relay-escrow-report-certora.pdf is still linked from references/protocol/security.mdx:65. Fix this →

2. Stale inbound links to the redirected path

references/protocol/guides/for-apps.mdx:67 and :69 both link to /references/protocol/depository/addresses. They resolve today only because of the redirect. Per §2.6 (root-relative internal links) and §4.2 ("update inbound links"), these should point straight at /references/protocol/addresses. Pre-existing, but this PR is the natural place to fix it. Fix this →

3. If the page is kept, re-run the generator instead of hand-editing one row

Line 7 records the provenance:

{/* Generated using: "curl https://api.relay.link/chains | jq '...'" */}

Removing a single row by hand leaves the table as an Aug-13 snapshot plus one later delta — so any chains added upstream since then are silently missing, and the table no longer corresponds to any single API response. If the page stays, re-run the full command.

I could not reach api.relay.link from this environment, so I can't independently confirm ancient8 is gone upstream — worth a quick check against the live response before merging.

4. Question: does dropping a chain deserve a record?

If ancient8 support is being sunset but its depository contract is still deployed, integrators with in-flight deposits may still need 0x4cd0…bc31. Silently deleting the row removes their only documented reference. references/protocol/** is explicitly out of scope for AGENTS.md v1 (§1.1), so §4.2's changelog requirement isn't binding here — flagging it as your call, not a blocker.

5. Adjacent, pre-existing (not from this PR)

  • snippets/Depositories.mdx:48 has a leftover debugger; statement in shipped client code — it pauses the depository table's fetch whenever a reader has devtools open.
  • That snippet returns null when typeof window === "undefined", so the depository table is client-render-only and absent from static HTML (no-JS / SEO). That's a legitimate argument for keeping a static fallback table — but it belongs on references/protocol/addresses.mdx, not on a redirected path.

What's fine

  • No stale references introduced: ancient8 / 888888888 appear nowhere else in the repo.
  • Row ordering (by Relay chain id, with non-EVM chains interleaved) is undisturbed by the deletion.
  • Frontmatter and table structure untouched; no AGENTS.md §2 violations in the diff itself.

Bottom line: the one-line deletion is correct in spirit but lands on dead content. I'd redirect the effort into #1 and #2 — delete the orphans and repoint the two inbound links — which fixes the drift permanently instead of once.
· branch docs-drift/src-260d4a1e33-5179282

@github-actions

github-actions Bot commented Aug 14, 2026

Copy link
Copy Markdown

Claude encountered an error after 2m 46s —— View job


Code review — PR #412

  • Read PR diff
  • Inspect references/protocol/depository/addresses.mdx
  • Check for other references to the removed chain
  • Post review

The diff itself is clean: one row (ancient8, EVM chain 888888888) removed from the address table, ordering preserved, no dangling mentions of ancient8 anywhere else in the repo. But the page it edits looks like the wrong target.


🔴 This edit lands on an orphaned page

references/protocol/depository/addresses.mdx is not reachable in the published docs:

  • docs.json:507-510 redirects /references/protocol/depository/addresses/references/protocol/addresses.
  • The file is not in navigation; the Contracts group (docs.json:265-271) lists references/protocol/addresses instead.

And the canonical page doesn't hand-maintain this list at all — references/protocol/addresses.mdx:29-31 renders it live:

The list below is fetched live from the [Chains API](https://api.relay.link/chains) and stays in sync as new chains are added.

<Depositories id="mainnetDepositories" env="mainnets" />

So if ancient8 really did lose its depository, the published page already reflects that automatically. This PR's net effect on the rendered docs is zero.

🟡 The static table is stale beyond this one row

Two independent signals that hand-maintaining this copy isn't working:

  • snippets/Depositories.mdx:20-27 maps VM types tvmtron-vm, hypevmhyperliquid-vm, lvmlighter-vm. None of those appear in the static table, even though Tron is a canonical chain name in AGENTS.md §5.
  • The file header (references/protocol/depository/addresses.mdx:7) documents a curl … | jq regeneration command, yet this change edits a single row by hand.

Suggested fix: delete references/protocol/depository/addresses.mdx rather than patching it, and repoint the two inbound links that still target the legacy path — references/protocol/guides/for-apps.mdx:67 and :69 both link to /references/protocol/depository/addresses. They resolve today only via the redirect; AGENTS.md §2.6 wants internal links on the canonical root-relative path.

Fix this →

If the table is being kept deliberately (e.g. as a static fallback for when the Chains API is unreachable), regenerate it wholesale with the documented command instead of removing rows one at a time — other rows have almost certainly drifted too.

⚪ Couldn't verify the factual claim

This environment has no network egress, so I couldn't hit https://api.relay.link/chains to confirm that ancient8 no longer exposes a protocol.v2.depository. Worth a manual check before merge — that's the one thing that makes this PR correct or incorrect.

Notes

  • Style: no objections. references/protocol/ is explicitly out of scope for AGENTS.md v1 (§1.1), and the diff pattern-matches the surrounding table.
  • Out of scope, pre-existing: snippets/Depositories.mdx:48 has a stray debugger; statement inside fetchChains(). It halts execution for any reader with devtools open on /references/protocol/addresses. Not this PR's doing, but worth a follow-up. Fix this →

No changes were made to the branch — this is review feedback only.
· Branch docs-drift/src-260d4a1e33-5179282

@greptile-apps

greptile-apps Bot commented Aug 14, 2026

Copy link
Copy Markdown

Greptile Summary

This change removes the Ancient8 depository address from the contract-address reference. A live comparison with https://api.relay.link/chains confirmed that Ancient8 is no longer published by Relay, so removing the stale row does not omit a currently supported depository address. No issues were found.

Confidence Score: 5/5

Safe to merge: the published chain registry does not include Ancient8, matching the updated reference table.

The focused live API check exercised the relevant documentation contract before and after the removal, received successful responses, and found no Ancient8 entry in either live response.

Files Needing Attention: No files need further attention.

T-Rex T-Rex Logs

What T-Rex did

  • Ran the authored Python comparison script to contrast the before-removal documentation against the checked-out table and issued live API requests to https://api.relay.link/chains for each comparison.
  • Observed 200 OK responses and Live Ancient8 chain count: 0 in both before-removal and after-removal checks, confirming the removed entry was stale and that the updated reference does not leave the API-published depository undocumented.

View all artifacts

T-Rex Ran code and verified through T-Rex

Reviews (1): Last reviewed commit: "Merge branch 'main' into docs-drift/src-..." | Re-trigger Greptile

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