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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 18 commits into from
Apr 30, 2025
Merged

docs(l2): clarify config parameters #2582

merged 18 commits into from
Apr 30, 2025
+29 −18

Conversation

tomip01
Copy link
Contributor

@tomip01 tomip01 commented Apr 24, 2025 •
edited
Loading

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

@tomip01
some docs
Loading
Loading status checks…
0efce07
@github-actions GitHub Actions
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 added 3 commits April 24, 2025 16:26
@tomip01
clarify dev_mode
Loading
Loading status checks…
42a6338
@tomip01
clarify arbitrary blob gas price
Loading
Loading status checks…
0bcfb0e
@tomip01
rename prover server to coordinator
Loading
Loading status checks…
ac380ba
@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
fedacking
fedacking approved these changes Apr 24, 2025
View reviewed changes
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

@tomip01
Merge branch 'main' into docs/l2-sequencer
Loading
Loading status checks…
9021ebd
@ilitteri ilitteri requested a review from MauroToscano April 25, 2025 15:25
tomip01 added 2 commits April 25, 2025 18:24
@tomip01
Merge branch 'main' into docs/l2-sequencer
Loading
Loading status checks…
41f622e
@tomip01
Merge branch 'main' into docs/l2-sequencer
Loading
Loading status checks…
4202288
ilitteri
ilitteri previously requested changes Apr 25, 2025
View reviewed changes
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
tomip01 and others added 2 commits April 28, 2025 10:18
@tomip01
Merge branch 'main' into docs/l2-sequencer
Loading
Loading status checks…
a33b38a
@ilitteri
Merge branch 'main' into docs/l2-sequencer
Loading
Loading status checks…
eb10ab9
@jrchatruc jrchatruc mentioned this pull request Apr 28, 2025
Merged
jrchatruc
jrchatruc reviewed Apr 28, 2025
View reviewed changes
jrchatruc
jrchatruc reviewed Apr 28, 2025
View reviewed changes
jrchatruc
jrchatruc reviewed Apr 28, 2025
View reviewed changes
jrchatruc
jrchatruc reviewed Apr 28, 2025
View reviewed changes
jrchatruc
jrchatruc reviewed Apr 28, 2025
View reviewed changes
jrchatruc
jrchatruc reviewed Apr 28, 2025
View reviewed changes
jrchatruc
jrchatruc reviewed Apr 28, 2025
View reviewed changes
tomip01 and others added 8 commits April 29, 2025 10:35
@tomip01
correct l1-watcher
Loading
Loading status checks…
c89384f
@tomip01
correct proof coordinator
Loading
Loading status checks…
f8e188f
@tomip01
clarify interval proposer
Loading
Loading status checks…
8f7fb30
@tomip01
fix l1 address
Loading
Loading status checks…
af333e3
@tomip01
clarify commit interval
Loading
Loading status checks…
3be6a5c
@tomip01
fix doc
Loading
Loading status checks…
8028d7b
@tomip01
clarify comment
Loading
Loading status checks…
53aa9ea
@tomip01
Merge branch 'main' into docs/l2-sequencer
Loading
Loading status checks…
20294e2
jrchatruc
jrchatruc reviewed Apr 30, 2025
View reviewed changes
@tomip01
update doc
Loading
Loading status checks…
6ac12f3
@jrchatruc jrchatruc dismissed ilitteri’s stale review April 30, 2025 14:19

Changes were addressed

@jrchatruc jrchatruc enabled auto-merge April 30, 2025 14:20
@jrchatruc jrchatruc added this pull request to the merge queue Apr 30, 2025
Merged via the queue into main with commit aa3c41b Apr 30, 2025
12 checks passed
@jrchatruc jrchatruc deleted the docs/l2-sequencer branch April 30, 2025 15:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fedacking fedacking

@jrchatruc jrchatruc

@ilitteri ilitteri

@MauroToscano MauroToscano

Assignees

@tomip01 tomip01

Labels
docs Improvements or additions to documentation L2 Rollup client
Projects
ethrex_l2
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Missing docs on how to configure the L2
4 participants
@tomip01 @fedacking @jrchatruc @ilitteri