Skip to content

Conversation

@m4sterbunny
Copy link
Contributor

@m4sterbunny m4sterbunny commented Dec 10, 2025

This PR implements issue(s) #1868

Checklist

  • [ na] I wrote new tests for my new core changes.
  • [ na] I have successfully ran tests, style checker and build against my new changes locally.
  • [ na] I have informed the team of any breaking changes if there are any.

Note

Updates README with client compatibility details, refreshed repository links, and minor wording/style tweaks.

  • Docs (README):
    • Add execution/consensus client compatibility details: Besu/Geth with Maru.
    • Refresh repositories list:
      • Clarify this repo (linea-monorepo) and note it maintains Linea-Besu plugins for sequencer/RPC nodes.
      • Replace linea-besu with linea-besu-upstream; remove linea-sequencer.
    • Minor copy/style edits: heading capitalization, phrasing of local dev guide, security policy casing, and note that docs are managed from a public repo.

Written by Cursor Bugbot for commit 312c665. This will update automatically on new commits. Configure here.

@cla-assistant
Copy link

cla-assistant bot commented Dec 10, 2025

CLA assistant check
All committers have signed the CLA.

@cla-assistant
Copy link

cla-assistant bot commented Dec 10, 2025

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@m4sterbunny m4sterbunny changed the title updates Readme to link to besu & minor style fixes updates Readme to link to active repos & minor style fixes Dec 10, 2025
README.md Outdated
- [linea-besu](https://github.com/Consensys/linea-besu): Fork of Besu to implement the Linea-Besu client
- [linea-sequencer](https://github.com/Consensys/linea-sequencer): A set of Linea-Besu plugins for the sequencer and RPC nodes
> Also maintains a set of Linea-Besu plugins for the sequencer and RPC nodes.
- [linea-besu](https://github.com/hyperledger/besu/): Besu execution client
Copy link
Collaborator

Choose a reason for hiding this comment

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

Now that we're using Besu, I'd just say "Besu" instead of "linea-besu" here:

- [Besu](https://github.com/hyperledger/besu/): Besu execution client

Maybe also list and link the mentioned plugins.

Finally, I'd also consider adding:

@julien-marchand what are your thoughts on this? anything missing here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@eloi010 Julien had similar comment on the constraints update --> my proposal is line 27: add besu to the "what is" section. Julien approved this for constraints, does it work here too?

Copy link
Collaborator

Choose a reason for hiding this comment

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

@julien-marchand is the best one to confirm here. I'd still consider mentioning other repos like Linea Besu Upstream. For Maru in line 27, I'd explicitly say that it is the consensus client in use.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@eloi010 apologies, you did clearly did mention that repo: added with suggested summary line

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants