Skip to content
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

Improve stack running documentation #603

Open
2 of 8 tasks
thedarkjester opened this issue Jan 25, 2025 · 0 comments
Open
2 of 8 tasks

Improve stack running documentation #603

thedarkjester opened this issue Jan 25, 2025 · 0 comments
Labels
C: Contracts Contracts Smart Contract related Coordinator Prover Tag to use for all work impacting the prover

Comments

@thedarkjester
Copy link
Collaborator

Description

Improve developer documentation for running various parts of the stack independently.

Note: some of the tasks required does have existing documentation, but there is a need to make it more navigable.

Motivation

There is a wide range of developers would like to test different aspects of the stack locally vs. on Sepolia testnet and it is beneficial for them to do so with the current stack's EVM version and framework.

Tasks

Add documentation for:

  • Running the L2 stack only
  • Running the L1->L2 messaging stack
  • Running the full stack with L2->L1 message (with an integration test verifier)
  • Running the full stack with real provers
  • Discuss with the content team how this can be exposed on the main documentation site

Acceptance criteria

  • Documentation is easy to read and covers all areas described

Remember to

  • Add the documentation label in case there is an impact on the documentation
  • Add priority and team labels
@thedarkjester thedarkjester added C: Contracts Contracts Smart Contract related Coordinator Prover Tag to use for all work impacting the prover labels Jan 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C: Contracts Contracts Smart Contract related Coordinator Prover Tag to use for all work impacting the prover
Projects
None yet
Development

No branches or pull requests

1 participant