Skip to content

Restructure delegation guide, add Rewards Eligibility pages, fix internal links" - #1135

Open
brandonleekramer wants to merge 3 commits into
mainfrom
reo-step-five
Open

brandonleekramer wants to merge 3 commits into
mainfrom
reo-step-five

Conversation

@brandonleekramer

Copy link
Copy Markdown
Member

Summary

This PR rewrites the delegation guide around how Delegators actually choose an Indexer, adds a new Indexing Rewards Eligibility page, and fixes the broken and redirected internal links across the English docs.

It has two commits:

  1. Delegation restructure and REO page. resources/delegating/ (two pages) becomes a single resources/delegating page, and the new indexing/rewards-eligibility page is added.
  2. Link fixes. Every internal link and anchor flagged by a docs-wide link check is fixed.

What changed

Delegation guide (/resources/delegating/)

  • One page instead of two. The undelegating guide is merged into the delegating page under "How to Undelegate on The Graph".
  • New step-by-step flow under "How to Delegate on The Graph":
    1. Choosing a Data Service
    2. Comparing Indexers
    3. Estimated Indexer APR: how it's calculated, why it moves, the Indexing Reward Cut and Query Fee Cut, your share of the delegation pool, and the ROI calculator
    4. Delegation Capacity and Rewards Eligibility: how the REO affects Delegators, and watching for the Grace and Unqualified statuses
    5. Indexer Contribution Quality: Subgraphs served, recent and lifetime query fees, lifetime indexing rewards
    6. Delegation Costs and Risks: no delegation tax, the 28-day undelegation period, future slashability
  • New images in public/img/ with -v2 names. The two formulas are re-rendered on the docs background, and the Explorer screenshots are updated. The old images are still in the repo and can be removed in a follow-up.
  • Old anchors still work. A HashRedirect maps 15 anchors from the old pages (for example #delegation-risks and #calculating-delegators-expected-return) to their new sections.

Indexing Rewards Eligibility (/indexing/rewards-eligibility/)

  • New page covering why the REO exists, the eligibility criteria and their history, projected changes, how to check status, what happens when an Indexer doesn't qualify, and a section for Delegators.
  • Added to the Indexing sidebar and linked from the delegating, indexing overview, and Horizon pages.

Redirects (nginx.conf)

  • /resources/delegating/delegating/ and the older /delegating/ and /network/delegating/ paths go to /resources/delegating/.
  • /resources/delegating/undelegating/ and /resources/roles/delegating/undelegating/ go to /resources/delegating/#how-to-undelegate-on-the-graph.
  • Retired SPS URLs (/sps/…, /substreams/sps/… and the SPS FAQ) now go to /substreams/overview/. Before, they led to a page that no longer exists.

Link fixes across the docs

  • /sps/introduction/ and /sps/triggers/ now point to the Substreams overview (3 pages).
  • Skills page: fixed links to Subgraph Uncrashable and the graph-ts API.
  • Subgraph manifest: removed four duplicate rows from the specVersion Releases table. They were the ones with the broken links.
  • advanced.mdx: added an ### Experimental Features heading so the #experimental-features links from three pages resolve.
  • Fixed anchors for full-text search, nested entity filtering, and specVersion releases.
  • Replaced 10 links that relied on redirects (/developing/creating-a-subgraph/, /deploying/…) with direct paths. One of them used to land at the top of the page instead of on "Testing Your Subgraph".

Testing

  • A link check across website/src/pages/en (internal paths, anchors, and images) reports 0 issues.
  • The changed pages pass Prettier.

Please review

  • Estimated APR method. The "How Estimated APR Is Calculated" section says Explorer annualizes the last 7 days of rewards that reached the delegation pool (after the Indexer's cuts) and divides them by the delegation that is actively earning, excluding thawing GRT. This is based on the Delegate page and the description of docs(delegating): clarify actively-earning delegation as the APR/APY denominator #1109. Can someone on the Explorer side confirm?
  • Cut names. Do "Indexing Reward Cut" and "Query Fee Cut" still match what Explorer shows under Horizon? In the Indexers table, the Query Fee Cut column has no % sign but the Indexing Reward Cut column does.
  • Undelegating through Arbiscan. These steps still describe calling unstake on the staking extension contract, which looks like pre-Horizon behavior. They weren't changed in this PR. Do they need updating for HorizonStaking?
  • REO page content. Please check the criteria, the projected changes, and the Delegator guidance.
  • Undelegation screenshot. Delegation-Unbonding-v2.png shows a personal ENS name and balances. Keep it as is, or blur that part?

Follow-ups (not in this PR)

  • Delete the old images once the v2 versions are approved: Delegation-Reward-Formula.png, Share-Forumla.png, Indexing-Reward-Cut.png and Delegation-Unbonding.png.

🤖 Generated with Claude Code

https://claude.ai/code/session_01HpT75tNWqJDzfGmEwZqRKD

brandonleekramer and others added 3 commits November 21, 2026 20:53
…ility page

- Flatten resources/delegating/ into a single resources/delegating page and
  merge the undelegating guide into it
- Rework the "How to Delegate" flow: data service, comparing Indexers,
  estimated APR (calculation, cuts, pool share, ROI calculator), capacity
  and rewards eligibility, contribution quality, costs and risks
- Replace formula and screenshot images with v2 versions that match the
  docs theme (old images kept for now)
- Add HashRedirect for anchors from the old delegating pages
- Add indexing/rewards-eligibility page and link it from related pages
- Update nginx redirects for the old delegating/undelegating URLs and point
  retired SPS URLs to the Substreams overview
- Update links to the new delegating path across the docs

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HpT75tNWqJDzfGmEwZqRKD
- Point retired /sps/ links to the Substreams overview
- Fix Skills page links to Subgraph Uncrashable and the graph-ts API
- Remove duplicate rows from the specVersion Releases table
- Add an Experimental Features heading in advanced.mdx and link to it
- Fix anchors for full-text search, nested entity filtering, and
  specVersion releases
- Replace redirected /developing/ and /deploying/ links with current paths

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HpT75tNWqJDzfGmEwZqRKD
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