Skip to content

DOC-2103: Remove dev network and update local development guidance - #2108

Draft
bgravenorst wants to merge 2 commits into
besu-eth:mainfrom
bgravenorst:DOC-2103
Draft

DOC-2103: Remove dev network and update local development guidance#2108
bgravenorst wants to merge 2 commits into
besu-eth:mainfrom
bgravenorst:DOC-2103

Conversation

@bgravenorst

@bgravenorst bgravenorst commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Do not merge this until confirmed in the Besu release. Post 26.8.0.

Description

Besu removed --network=dev in besu-eth/besu#10836.
The flag isn't merely deprecated: Besu logs a framed warning and then aborts, so every
--network=dev example in the docs was a command that fails at startup. The dev network relied on
ethash.fixeddifficulty and proof of work mining, which was removed earlier, so it can no longer
produce blocks. The same PR also deleted the dev profile, which these docs never listed.

Reference (options.md)

  • Removed the dev row from the --network table.
  • Added a "Removed networks" warning mirroring the CLI output, pointing to Ephemery and Kurtosis.
  • Corrected the ETC/Mordor note: support was removed in besu#9671, not deprecated.
  • Dropped the --network=dev exceptions from --bootnodes and --sync-mode, which makes the
    SNAP default unconditional for all remaining named networks.

Examples that no longer start

  • Public metrics.md uses --network=ephemery, with a note that Ephemery needs a consensus client.
  • Private opentelemetry.md and splunk.md use --genesis-file instead, since readers of
    private-networks pages already run their own network, with links to the Developer Quickstart.
  • Removed the "run a node for testing" commands from both Docker pages and private start-node.md.
    Their premise was a single command that produces blocks, and no single command replaces that. The
    security :::caution from start-node.md is kept, relocated under "Run a node on a private
    network".

Replacement guidance for local development

Removing those sections would otherwise leave readers without an answer for how to run a node
locally, so the supported alternatives are documented instead:

  • Public start-node.md gains a "Run a node for local development" section covering Ephemery
    (with a consensus client), Kurtosis, and defining your own genesis file for a private network.
    Public networks previously had no local-development guidance anywhere.
  • Both Docker pages keep the Run a node for testing heading, now as a short signpost to the
    relevant page. Keeping the original wording preserves the #run-a-node-for-testing anchor that
    external links and search results point at.
  • Private start-node.md points readers without a network to the Developer Quickstart or the QBFT
    tutorial.

Other updates

  • Removed the dev-mode genesis paragraphs from both start-node.md pages.
  • Reframed "Development mode" in accounts-for-testing.md as "Predefined test accounts". The
    accounts still ship in dev.json and remain valid as a template for your own genesis file.

Related issue(s)

Fixes #2103

Preview

Besu no longer starts with --network=dev, so replace or remove the examples
that used it and correct the affected reference entries.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Co-authored-by: Cursor <cursoragent@cursor.com>
@bgravenorst
bgravenorst requested a review from a team as a code owner August 18, 2026 04:14
@vercel

vercel Bot commented Aug 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
besu-docs Ready Ready Preview Aug 19, 2026 10:59pm

Request Review

Removing the "Run a node for testing" sections left readers without an
answer for how to run a node locally. Add the supported alternatives
(Ephemery, Kurtosis, and private networks) to the public Start Besu
topic, and signpost them from the Docker pages under the original
heading so existing inbound links still land on the answer.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Co-authored-by: Cursor <cursoragent@cursor.com>
@bgravenorst
bgravenorst marked this pull request as ready for review August 19, 2026 23:02

@alexandratran alexandratran left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

lgtm

@bgravenorst
bgravenorst marked this pull request as draft August 19, 2026 23:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix: Deprecate network=dev

3 participants