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

chore(docs): Links to Aztec docs from errors #3423

Merged
merged 8 commits into from
Nov 28, 2023
Merged

Conversation

catmcgee
Copy link
Contributor

@catmcgee catmcgee commented Nov 3, 2023

Description

This links to Aztec docs from Aztec-specific errors

Problem*

Resolves AztecProtocol/aztec-packages#2905 (in aztec-packages repo)

Summary*

Additional Context

Needs AztecProtocol/aztec-packages#3113 to be merged first

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.

Copy link
Contributor

@benesjan benesjan left a comment

Choose a reason for hiding this comment

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

The links currently do not work. Is it because the docs were not yet re-deployed?

Copy link
Member

@TomAFrench TomAFrench left a comment

Choose a reason for hiding this comment

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

These links are working now

* master: (65 commits)
  chore: nargo fmt (#3612)
  fix: Flatten public inputs according to their index in numerial rather than ascii order (#3605)
  chore(docs): correct typo in `poseidon_hash` example in standard_library (#3608)
  feat: aztec-packages (#3599)
  chore: update code formatting to prevent parameter line wrapping (#3588)
  chore: Update ACIR artifacts (#3597)
  chore: Pull out aztec macros to their own crate and create an API for them in the compiler frontend (#3578)
  chore(ci): deduplicate javascript testing workflows (#3563)
  chore: Release Noir(0.19.4) (#3548)
  chore: update barretenberg to 0.16.0 (#3598)
  chore: move suite of test programs up to repository root (#3485)
  feat: send and receive unflattened public inputs to backend (#3543)
  feat: remove type arrays for flat slices (#3466)
  chore: clippy fix (#3561)
  chore: fix wrapping issue for constraints (#3590)
  feat: add support for tuple values in `noir_codegen` (#3592)
  chore: Remove concept of storage slot from the compiler (#3582)
  chore: Update ACIR artifacts (#3591)
  feat: export `CompiledCircuit` from codegened TS (#3589)
  fix: use 128 bits for constant bit shift (#3586)
  ...
@TomAFrench TomAFrench marked this pull request as ready for review November 28, 2023 15:33
@TomAFrench TomAFrench added this pull request to the merge queue Nov 28, 2023
Merged via the queue into master with commit d983a08 Nov 28, 2023
33 checks passed
@TomAFrench TomAFrench deleted the aztec-error-links branch November 28, 2023 15:59
TomAFrench added a commit that referenced this pull request Nov 28, 2023
* master: (47 commits)
  chore(docs): Links to Aztec docs from errors (#3423)
  chore: nargo fmt (#3612)
  fix: Flatten public inputs according to their index in numerial rather than ascii order (#3605)
  chore(docs): correct typo in `poseidon_hash` example in standard_library (#3608)
  feat: aztec-packages (#3599)
  chore: update code formatting to prevent parameter line wrapping (#3588)
  chore: Update ACIR artifacts (#3597)
  chore: Pull out aztec macros to their own crate and create an API for them in the compiler frontend (#3578)
  chore(ci): deduplicate javascript testing workflows (#3563)
  chore: Release Noir(0.19.4) (#3548)
  chore: update barretenberg to 0.16.0 (#3598)
  chore: move suite of test programs up to repository root (#3485)
  feat: send and receive unflattened public inputs to backend (#3543)
  feat: remove type arrays for flat slices (#3466)
  chore: clippy fix (#3561)
  chore: fix wrapping issue for constraints (#3590)
  feat: add support for tuple values in `noir_codegen` (#3592)
  chore: Remove concept of storage slot from the compiler (#3582)
  chore: Update ACIR artifacts (#3591)
  feat: export `CompiledCircuit` from codegened TS (#3589)
  ...
TomAFrench added a commit that referenced this pull request Nov 30, 2023
* master: (216 commits)
  chore(docs): address visibility issues in docs (#3643)
  chore: type formatting (#3618)
  fix: Restrict fill_internal_slices pass to acir functions (#3634)
  chore(docs): docs for v0.19.4 (#3601)
  feat: aztec-packages (#3626)
  chore: Move tests to the correct root (#3633)
  feat: Implement integer printing (#3577)
  fix: corrected the formatting of error message parameters in index out of bounds error (#3630)
  chore: Update ACIR artifacts (#3619)
  chore(debugger): Run debugger REPL in thread (#3611)
  chore: remove deprecated method (#3625)
  feat: Implement raw string literals (#3556)
  fix: docker builds (#3620)
  feat: Copy on write optimization for brillig (#3522)
  chore: separate methods in `dc_crate` into their own modules (#3585)
  feat: add special case for boolean AND in acir-gen (#3615)
  chore: Update ACIR artifacts (#3614)
  chore: remove `get_number_sequence` foreign calls (#3613)
  feat: Add package version to Nargo.toml metadata (#3427)
  chore(docs): Links to Aztec docs from errors (#3423)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create aztec noir errors page in docs
3 participants