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

Auto-generate aztec-nr references #11624

Open
jzaki opened this issue Jan 30, 2025 · 0 comments
Open

Auto-generate aztec-nr references #11624

jzaki opened this issue Jan 30, 2025 · 0 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@jzaki
Copy link
Contributor

jzaki commented Jan 30, 2025

Currently this is aztec-nr reference documentation is generated.

With Noir syntactically being closer to Rust, assess if tweaking cargo doc for Noir language is a more robust solution.

Potential breakdown of sub-tasks:

  1. Test generating reference docs from a simple Noir program/library
  2. Generate reference docs from aztec.nr libs
  3. Stretch goal - ensure docs can render well within a docusaurus docs site. Eg Aztec-nr reference here
@jzaki jzaki self-assigned this Jan 30, 2025
@jzaki jzaki added the good first issue Good for newcomers label Jan 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant