linea-monorepo icon indicating copy to clipboard operation
linea-monorepo copied to clipboard

Published 20 hours ago • verified publisher icon Consensys

feat(docs): Improve documentation for local coordinator development

Open CreeptoGengar opened this issue 6 months ago • 1 comments

This PR implements issue #341

Added comprehensive documentation for building and running the coordinator service locally to address the lack of onboarding documentation mentioned in issue #341.

Here are the changes:

  • New local-development-guide.md with detailed instructions for building and running the coordinator
  • Instructions for creating local Docker images
  • Configuration guidance
  • Troubleshooting steps
  • Referenced the new guide in both README.md and get-started.md

Checklist

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

CreeptoGengar avatar May 21 '25 15:05 CreeptoGengar

CLA assistant check
All committers have signed the CLA.

cla-assistant[bot] avatar May 21 '25 15:05 cla-assistant[bot]

Thanks @CreeptoGengar for this PR, I'd added some comments, please have a look :)

jonesho avatar Jun 11 '25 07:06 jonesho

LGTM, just added a few suggestions, thanks

jonesho avatar Jun 12 '25 06:06 jonesho

@jonesho tnx for your assistance and support, if there's something else you'd like me to fix, I'm open to help

CreeptoGengar avatar Jun 12 '25 12:06 CreeptoGengar

Merged, thanks @CreeptoGengar for the effort 👍

jonesho avatar Jun 12 '25 19:06 jonesho