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

Docs updates for 64-bit multi-threaded Cannon #1066

Open
4 tasks
pauldowman opened this issue Nov 1, 2024 · 5 comments
Open
4 tasks

Docs updates for 64-bit multi-threaded Cannon #1066

pauldowman opened this issue Nov 1, 2024 · 5 comments

Comments

@pauldowman
Copy link
Contributor

pauldowman commented Nov 1, 2024

Cannon is undergoing a major refactor, it will support multi-threading and will become a 64-bit architecture instead of 32-bit.

This won't introduce any new sections into the docs but changes some details of sections that reference Cannon and op-challenger.

Here's a list of things that will be affected (incomplete - TODO)

  • Details on the Cannon page (e.g. contract names), reference to single thread context
  • Challenger command-line options (?)
  • Breaking changes doc similar to this one
  • TODO what else
@pauldowman pauldowman transferred this issue from ethereum-optimism/optimism Nov 1, 2024
@pauldowman
Copy link
Contributor Author

@mbaxter @Inphi can you take a look at the checklist here and add general types of things that need documenting?

Or I'm also wondering if the changes are small and specific enough that the easiest thing might just be for one of you to go through the docs repo for any cannon references and just make a PR?

@Inphi
Copy link

Inphi commented Nov 4, 2024

The challenger cli options don't change. Otherwise, the list covers the docs changes. Specifically, the cannon page on docs.optimism.io should be updated.

@mbaxter
Copy link

mbaxter commented Nov 4, 2024

There's also a page on MIPS.sol that looks like it should be updated.

@mbaxter
Copy link

mbaxter commented Nov 5, 2024

Also, there's a relevant issue in the specs repo suggesting the MIPS.sol doc moves to the specs repo.

@pauldowman
Copy link
Contributor Author

pauldowman commented Nov 22, 2024

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

No branches or pull requests

3 participants