Skip to content

Developer docs: add goal-based wayfinding on the hub and intro pages#18016

Merged
wackerow merged 1 commit into
ethereum:devfrom
franrob-projects:docs/developer-wayfinding-improvements
Apr 23, 2026
Merged

Developer docs: add goal-based wayfinding on the hub and intro pages#18016
wackerow merged 1 commit into
ethereum:devfrom
franrob-projects:docs/developer-wayfinding-improvements

Conversation

@franrob-projects
Copy link
Copy Markdown
Contributor

Description

Two small, additive edits that help developers self-route through the docs based on what they are actually trying to build, rather than reading the modules top-to-bottom.

public/content/developers/docs/index.md

  • New section Pick a starting point above the Development modules, with four goal-based entry points (dapp, smart contract, node / staking, reading the protocol in order).
  • Tightened the wording of the existing "edit on GitHub" paragraph so it reads as a note rather than front-and-centre lead copy.

public/content/developers/docs/intro-to-ethereum/index.md

  • New section Where to go next directly before Further reading, mirroring three of the paths from the hub page. Readers finishing the intro don't get dropped back into the generic module list.

Motivation

The hub page currently opens with a generic intro and then three <DeveloperDocsLinks> blocks. Readers who know what they're trying to build (dapp vs. smart contract vs. running a node) still have to guess which of the three lists starts them off in the right place. Adding a goal-based block above the modules fixes that without touching the existing module ordering.

The mirrored block at the end of intro-to-ethereum gives readers an obvious next step based on the same goals, so they don't have to go back to the hub to re-orient.

Scope

  • Two files changed, 18 lines added, 1 line modified.
  • All new headings use the {#kebab-case-id} convention from docs/header-ids.md.
  • All linked target pages already exist. Verified by listing public/content/developers/docs/.
  • No component, route, sidebar, or i18n key changes required.

Issue

Not tied to a specific issue. Happy to open one first if that is the preferred process for wayfinding-style additions.

Two small, additive changes to help developers self-route through the
docs based on what they're actually trying to build.

public/content/developers/docs/index.md
  Adds a "Pick a starting point" section above the development
  modules with four goal-based entry points (dapp, smart contract,
  node/staking, reading the protocol in order). Also tightens the
  second paragraph of the intro so the "how to edit this" note reads
  as a note rather than a full sentence of the lead copy.

public/content/developers/docs/intro-to-ethereum/index.md
  Adds a "Where to go next" section before Further reading, giving
  the same three goal-based paths. Mirrors the hub page so readers
  arriving at the end of the intro aren't dropped back into the
  generic nav.

The linked target pages already exist; no new routes required.
All new headings follow the existing {#kebab-id} convention.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 22, 2026

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit 4f1f12a
🔍 Latest deploy log https://app.netlify.com/projects/ethereumorg/deploys/69e8d618480963000852fa42
😎 Deploy Preview https://deploy-preview-18016.ethereum.it
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
7 paths audited
Performance: 58 (no change from production)
Accessibility: 93 (no change from production)
Best Practices: 100 (no change from production)
SEO: 98 (🔴 down 1 from production)
PWA: 59 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added the content 🖋️ This involves copy additions or edits label Apr 22, 2026
franrob-projects added a commit to franrob-projects/portfolio that referenced this pull request Apr 23, 2026
- src/pages/projects.tsx: ethereum/ethereum-org-website#18016 added
  to the top of CONTRIBUTIONS.
- blog/2026-04-22-ethereum-org-wayfinding.md: new post explaining why
  the PR exists and how to structure a docs PR against a protocol
  repo so reviewers can say yes faster.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks for the addition @franrob-projects, pulling this in

@wackerow wackerow merged commit 3dbf3cf into ethereum:dev Apr 23, 2026
7 checks passed
@wackerow
Copy link
Copy Markdown
Member

@all-contributors please add @franrob-projects for content

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content 🖋️ This involves copy additions or edits

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants