Skip to content

Conversation

dannywillems
Copy link
Member

  • Redirect build instructions from Node Runners to Developer Getting Started guide for consistency and maintainability
  • Add run-node Makefile target with NETWORK and VERBOSITY variables
  • Focus Node Runners documentation on binary execution and Makefile variables only
  • Document comprehensive CLI parameters in Rust code with examples
  • Add detailed multiaddr format documentation for peer configuration
  • Link to Rust API documentation for complete parameter reference
  • Reference comprehensive Archive Node documentation
  • Fix parameter name from log-level to verbosity to match actual CLI

This creates a cleaner separation where build instructions are centralized in the tested Developer guide, while Node Runners focuses on runtime configuration using simple Makefile targets.

@dannywillems dannywillems marked this pull request as draft July 31, 2025 11:43
@dannywillems dannywillems force-pushed the dw/update-docs-node-runners branch from 028283c to 9d9e429 Compare July 31, 2025 14:39
@dannywillems dannywillems force-pushed the dw/update-docs-node-runners branch 2 times, most recently from d7a824e to 15f2498 Compare August 12, 2025 19:45
@dannywillems dannywillems requested a review from 0xMimir August 12, 2025 19:45
@dannywillems dannywillems marked this pull request as ready for review August 12, 2025 19:47
- Redirect build instructions from Node Runners to Developer Getting
  Started guide for consistency and maintainability
- Add run-node Makefile target with NETWORK and VERBOSITY variables
- Focus Node Runners documentation on binary execution and Makefile
  variables only
- Document comprehensive CLI parameters in Rust code with examples
- Add detailed multiaddr format documentation for peer configuration
- Link to Rust API documentation for complete parameter reference
- Reference comprehensive Archive Node documentation
- Fix parameter name from log-level to verbosity to match actual CLI

This creates a cleaner separation where build instructions are
centralized in the tested Developer guide, while Node Runners focuses
on runtime configuration using simple Makefile targets.
@dannywillems dannywillems force-pushed the dw/update-docs-node-runners branch from 15f2498 to 37aa78c Compare August 12, 2025 19:51
@dannywillems
Copy link
Member Author

The doc related job is fixed later in #1284

Copy link
Contributor

@0xMimir 0xMimir left a comment

Choose a reason for hiding this comment

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

LGTM

@dannywillems
Copy link
Member Author

Merging despite test-doc-commands failing. Will be fixed later.

@dannywillems dannywillems merged commit b73d276 into develop Aug 13, 2025
54 of 55 checks passed
@dannywillems dannywillems deleted the dw/update-docs-node-runners branch October 16, 2025 11:52
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.

2 participants