Skip to content

docs(l2): clarify config parameters #2582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

docs(l2): clarify config parameters #2582

wants to merge 7 commits into from

Conversation

tomip01
Copy link
Contributor

@tomip01 tomip01 commented Apr 24, 2025

Motivation

This pull request updates the crates/l2/docs/sequencer.md documentation to improve clarity and provide more detailed descriptions of configuration parameters.

Description

  • Renamed "Prover Server" to "Proof Coordinator".
  • Expanded descriptions of configuration parameters under [deployer], [watcher], [proposer], and [committer] sections.

Closes #2525

Copy link

Lines of code report

Total lines added: 0
Total lines removed: 7
Total lines changed: 7

Detailed view
+--------------------------------------------+-------+------+
| File                                       | Lines | Diff |
+--------------------------------------------+-------+------+
| ethrex/crates/l2/sequencer/l1_committer.rs | 387   | -7   |
+--------------------------------------------+-------+------+

@tomip01 tomip01 self-assigned this Apr 24, 2025
@tomip01 tomip01 added docs Improvements or additions to documentation L2 Rollup client labels Apr 24, 2025
@tomip01 tomip01 marked this pull request as ready for review April 24, 2025 20:07
@tomip01 tomip01 requested a review from a team as a code owner April 24, 2025 20:07
@tomip01 tomip01 changed the title some docs docs(l2): clarify config parameters Apr 24, 2025
Copy link
Contributor

@fedacking fedacking left a comment

Choose a reason for hiding this comment

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

LGTM

@ilitteri ilitteri requested a review from MauroToscano April 25, 2025 15:25
Copy link
Contributor

@ilitteri ilitteri left a comment

Choose a reason for hiding this comment

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

No changes needed, just blocking the PR until requested reviewers review the PR

@ilitteri ilitteri requested a review from jrchatruc April 25, 2025 22:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation L2 Rollup client
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Missing docs on how to configure the L2
3 participants