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.

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

doc: improve Kernel assembly documentation #300

Open
6 tasks
Nashtare opened this issue Jun 18, 2024 · 0 comments
Open
6 tasks

doc: improve Kernel assembly documentation #300

Nashtare opened this issue Jun 18, 2024 · 0 comments
Labels
crate: evm_arithmetization Anything related to the evm_arithmetization crate. documentation Improvements or additions to documentation
Milestone
System strengthening

Comments

@Nashtare
Copy link
Collaborator

Nashtare commented Jun 18, 2024 •
edited
Loading

Somewhat related to #299, it would be beneficial to improve the quality of the current documentation throughout the assembly codebase.

Something like:

  • file headers
  • documentation for all global labels
  • stack descriptions (before / after) for
    • global labels
    • macros
  • expanded documentation on some specific / complex components if any
@Nashtare Nashtare added crate: evm_arithmetization Anything related to the evm_arithmetization crate. documentation Improvements or additions to documentation labels Jun 18, 2024
@Nashtare Nashtare modified the milestone: Cleanups and Misc. Jun 21, 2024
@Nashtare Nashtare added this to the System strengthening milestone Jul 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
crate: evm_arithmetization Anything related to the evm_arithmetization crate. documentation Improvements or additions to documentation
Projects
Zero EVM
Status: Backlog
Milestone
System strengthening
Development

No branches or pull requests
1 participant
@Nashtare