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

Use CLAP generate for autogeneration of Nargo command reference #128

Closed
signorecello opened this issue Jan 22, 2024 · 2 comments · Fixed by noir-lang/noir#4149
Closed

Use CLAP generate for autogeneration of Nargo command reference #128

signorecello opened this issue Jan 22, 2024 · 2 comments · Fixed by noir-lang/noir#4149
Assignees
@signorecello
Labels
Noir Docs

Comments

@signorecello
Copy link
Collaborator

Noir already uses CLAP for the CLI info. It should be fairly easy to to use it for autogen docs as well, which would increase reliability and reduce time needed to manually update Nargo commands reference 🥇
@signorecello signorecello self-assigned this Jan 22, 2024
@signorecello
Copy link
Collaborator Author

signorecello commented Feb 1, 2024 •
edited
Loading

@TomAFrench opened a PR in noir-lang to address this, checking if this is ongoing or stale but most likely this is being actively worked on

@signorecello
Copy link
Collaborator Author

moving to blocked even though it's not blocked, just on hold for now until I figure out who will own this

@TomAFrench TomAFrench mentioned this issue Feb 2, 2024
Merged
5 tasks
github-merge-queue bot pushed a commit to noir-lang/noir that referenced this issue Feb 8, 2024
@TomAFrench
chore(docs): codegen reference docs for nargo CLI (#4149)
0e07303 
# Description

## Problem\*

Resolves #4136 
Resolves AztecProtocol/dev-rel#128
## Summary\*

This PR codegens the reference material for the nargo CLI to avoid us
having to copy documentation from the code over to a markdown file.

The exact format of the codegenned markdown isn't final and we can
iterate on this but it guarantees completeness.

## Additional Context


## Documentation\*

Check one:
- [ ] No documentation needed.
- [x] Documentation included in this PR.
- [ ] **[Exceptional Case]** Documentation to be submitted in a separate
PR.

# PR Checklist\*

- [x] I have tested the changes locally.
- [x] I have formatted the changes with [Prettier](https://prettier.io/)
and/or `cargo fmt` on default settings.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@signorecello signorecello

Labels
Noir Docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore(docs): codegen reference docs for nargo CLI noir-lang/noir
1 participant
@signorecello