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

chore(docs): codegen reference docs for nargo CLI #4149

Merged
merged 5 commits into from
Feb 8, 2024
Merged

chore(docs): codegen reference docs for nargo CLI #4149

merged 5 commits into from
Feb 8, 2024

Conversation

TomAFrench
Copy link
Member

@TomAFrench TomAFrench commented Jan 24, 2024 •
edited
Loading

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.
  • Documentation included in this PR.
  • [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 24, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 24, 2024 •
edited
Loading

🚀 Deployed on https://65c42b2f69b06912f11d0bee--noir-docs.netlify.app

@TomAFrench TomAFrench force-pushed the tf/codegen-nargo-reference-docs branch from e1c4f0d to 953d284 Compare January 29, 2024 15:13
@TomAFrench TomAFrench force-pushed the tf/codegen-nargo-reference-docs branch from 953d284 to 42b4456 Compare January 29, 2024 15:14
@Savio-Sou
Copy link
Collaborator

cc @noir-lang/developerrelations

@signorecello
Copy link
Contributor

Thank you, this is exactly what we needed!

Now if we only could do the same for the stdlib, that would allow for that explanation/reference separation @noir-lang/developerrelations would like to have. But that's not possible at this point, due to the fact the stdlib is Noir so CLAP shouldn't work there.

Our end goal is for engineers to simply incorporate some decorators with their code and don't have to think much about the docs.

@signorecello signorecello mentioned this pull request Feb 1, 2024
Closed
@TomAFrench
Merge branch 'master' into tf/codegen-nargo-reference-docs
d40c81b 
* master: (22 commits)
  feat: remove predicate from `sort` intrinsic function (#4228)
  chore: add test for missing lambda closure environment (#2120) (#4212)
  chore(docs): Updates following `is_recursive` flag removal (#4199)
  fix: from field with constant values (#4226)
  feat: Option expect method (#4219)
  feat: Evaluation of dynamic assert messages (#4101)
  chore(docs): XOR typo in docs (#4223)
  fix: apply range constraints to return values from unconstrained functions (#4217)
  fix(lsp): replace panics with errors (#4209)
  feat: Improve Error Handling for Cargo in Bootstrap Script (#4211)
  fix: prevent declarations of blackbox functions outside of the stdlib (#4177)
  feat: disable unused variable checks on low-level and oracle functions (#4179)
  chore: Rename acir_docs.md to README.md (#4208)
  feat: remove replacement of boolean range opcodes with `AssertZero` opcodes (#4107)
  chore(docs): updating docs to match new recursion interfacee (#4187)
  feat!: Sync commits from `aztec-packages` (#4144)
  feat: multiply first to allow more ACIR gen optimizations (#4201)
  feat: Move bounded_vec into the noir stdlib (#4197)
  chore: simplify marking black box function outputs as solvable (#4194)
  chore(doc): Add docs for `assert_max_bit_size` (#4196)
  ...
@TomAFrench
chore: add exception for clap-markdown in cargo-deny
7bfda9c
@TomAFrench TomAFrench marked this pull request as ready for review February 2, 2024 13:09
@TomAFrench
Copy link
Member Author

Also looked at https://github.com/clap-rs/clap/tree/master/clap_mangen but there's no easy way to display roff in docusaurus so we'd have to go down the route of https://github.com/jgm/pandoc.

If we go down that route then we'd lose any control over how we display this information so it's probably best to just use clap_markdown as we can modify that as necessary.

@TomAFrench TomAFrench requested review from signorecello and a team February 2, 2024 14:03
@TomAFrench
Copy link
Member Author

image
Yeah, I realise I'm breaking the warning I wrote in deny.toml, it's fine for now as we're not publishing nargo_cli to crates.io anyway.

critesjosh
critesjosh approved these changes Feb 8, 2024
View reviewed changes
Copy link
Contributor

@critesjosh critesjosh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@signorecello signorecello added this pull request to the merge queue Feb 8, 2024
Merged via the queue into master with commit 0e07303 Feb 8, 2024
34 checks passed
@signorecello signorecello deleted the tf/codegen-nargo-reference-docs branch February 8, 2024 08:17
@Savio-Sou Savio-Sou mentioned this pull request Apr 29, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@critesjosh critesjosh critesjosh approved these changes

@signorecello signorecello signorecello approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document nargo compile --force Use CLAP generate for autogeneration of Nargo command reference
4 participants
@TomAFrench @Savio-Sou @signorecello @critesjosh