docs: add BalanceViewer configuration namespace - #351
Open
Marchhill wants to merge 1 commit into
Open
Conversation
The BalanceViewer plugin (served at /balances) ships enabled by default (BalanceViewer.Enabled = true), but the config reference omitted the namespace entirely. Add BalanceViewer.Enabled and BalanceViewer.SiblingProbePorts, matching the DocGen output format. DocGen will reproduce this automatically on the next release regeneration. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
The added BalanceViewer documentation matches the established formatting and naming conventions in configuration.md and introduces no apparent inconsistencies.
Pull request overview
Adds documentation for the previously missing BalanceViewer configuration namespace in the main configuration reference, aligning the docs with the feature’s stated defaults and the existing DocGen-style formatting used throughout the file.
Changes:
- Documented
BalanceViewer.Enabledincluding CLI/env/config examples and defaulttrue. - Documented
BalanceViewer.SiblingProbePortsincluding CLI/env/config examples and default port list8545,8546,8547,8548,8549,8550.
File summaries
| File | Description |
|---|---|
| docs/fundamentals/configuration.md | Adds a new BalanceViewer config namespace section matching the surrounding autogen/DocGen format and conventions. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds the missing
BalanceViewernamespace to the configuration reference (docs/fundamentals/configuration.md):BalanceViewer.Enabled— defaults totrue(the plugin serves the/balancesUI and its token/NFT auto-detection out of the box)BalanceViewer.SiblingProbePorts— defaults to8545,8546,8547,8548,8549,8550Why
The config reference documents every config namespace except
BalanceViewer, so it doesn't reflect that the balance viewer (and its detection) ships on by default. This came up when verifying the default: the code (IBalanceViewerConfig.Enabled,DefaultValue = "true", plus the plugin being registered inNethermindPlugins) confirms it is enabled by default, but the docs were silent.Notes
feature/balance-viewer-token-detection, Nethermind PR #12446) and not yet released.DocGenoutput format, so the release-timeUpdate docsworkflow will reproduce it automatically once the feature ships — this just documents it early / corrects the omission.🤖 Generated with Claude Code