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

Add documentation #3

Open
Nashtare opened this issue Jan 24, 2024 · 1 comment
Open

Add documentation #3

Nashtare opened this issue Jan 24, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone
x Misc.

Comments

@Nashtare
Copy link
Contributor

Add documentation throughout the workspace + README for easier use by external parties.

Ideally supporting

#![cfg_attr(docsrs, feature(doc_cfg))]
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(missing_docs)]
@Nashtare Nashtare added the documentation Improvements or additions to documentation label Jan 24, 2024
@Nashtare Nashtare self-assigned this Jan 24, 2024
@Nashtare
Copy link
Contributor Author

@BGluth Assigning myself to it so I can dive into the internals and understand them while writing the doc, if you don't mind!

@Nashtare Nashtare added this to Zero EVM Feb 9, 2024
@Nashtare Nashtare moved this to Backlog in Zero EVM Feb 11, 2024
@hratoanina hratoanina assigned hratoanina and unassigned Nashtare Feb 20, 2024
@pgebheim pgebheim added this to the Cleanups and Misc. milestone Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
Zero EVM
Status: Backlog
Milestone
x Misc.
Development

No branches or pull requests
3 participants
@pgebheim @hratoanina @Nashtare