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

Bring nested recursion example into noir-lang/noir #4410

Open
1 task done
Savio-Sou opened this issue Feb 22, 2024 · 2 comments · May be fixed by #4969
Open
1 task done

Bring nested recursion example into noir-lang/noir #4410

Savio-Sou opened this issue Feb 22, 2024 · 2 comments · May be fixed by #4969
Assignees
Labels
CI documentation Improvements or additions to documentation enhancement New feature or request recursion Recursive proving / proof aggregation

Comments

@Savio-Sou
Copy link
Collaborator

Savio-Sou commented Feb 22, 2024

Prerequisites

@Savio-Sou Savio-Sou added documentation Improvements or additions to documentation recursion Recursive proving / proof aggregation labels Feb 22, 2024
@Savio-Sou Savio-Sou changed the title Update the "Recursion on NoirJS" how-to guide according to v0.24.0-friendly noir-example Update the "Recursion on NoirJS" how-to guide according to v0.25.0-friendly noir-example Mar 13, 2024
github-merge-queue bot pushed a commit that referenced this issue Mar 21, 2024
…ications (#4466)

# Description

## Problem

Other how-to guides not mentioned in #4410 need to be updated to the
v0.24.0 function naming.

## Summary

This pull request updates the documentation to match the function naming
conventions introduced in version 0.24.0. Specifically, it changes
references from `generateFinalProof` and `verifyFinalProof` to
`generateProof` and `verifyProof` respectively.

## Additional Context

The changes were made across multiple documentation files, including
tutorials and how-to guides.

## Documentation

- [x] Documentation included in this 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.

---------

Co-authored-by: josh crites <jc@joshcrites.com>
TomAFrench pushed a commit that referenced this issue Apr 3, 2024
…ications (#4466)

# Description

## Problem

Other how-to guides not mentioned in #4410 need to be updated to the
v0.24.0 function naming.

## Summary

This pull request updates the documentation to match the function naming
conventions introduced in version 0.24.0. Specifically, it changes
references from `generateFinalProof` and `verifyFinalProof` to
`generateProof` and `verifyProof` respectively.

## Additional Context

The changes were made across multiple documentation files, including
tutorials and how-to guides.

## Documentation

- [x] Documentation included in this 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.

---------

Co-authored-by: josh crites <jc@joshcrites.com>
@Savio-Sou Savio-Sou changed the title Update the "Recursion on NoirJS" how-to guide according to v0.25.0-friendly noir-example Update the "Recursion on NoirJS" how-to guide with v0.26.0 example Apr 24, 2024
@jzaki
Copy link
Contributor

jzaki commented Apr 29, 2024

Details from Tom:

  • A top-level examples would also be fine for now (later docs/examples with docs moved to docs/site)
  • Remove use of codegen command
  • We'll need to have them pull the dependencies from the workspace rather than being fixed to a particular npm version.
    • If we're referencing the package.json in the docs then we're going to need to swap out the dependencies for the npm versions when pushing a new release.
  • We're going to need to run these as part of CI so we can enforce that the code still works and we can fix as needed.

@jzaki jzaki linked a pull request May 3, 2024 that will close this issue
5 tasks
@Savio-Sou Savio-Sou changed the title Update the "Recursion on NoirJS" how-to guide with v0.26.0 example Update the "Recursion on NoirJS" how-to guide May 23, 2024
@Savio-Sou
Copy link
Collaborator Author

Savio-Sou commented May 23, 2024

Following #5072, proving and verification workflow would be scoped out of NoirJS.

The PR includes updates to the doc page. Commenting here for @noir-lang/developerrelations and readers' awareness in case it leads to changes to existing / planned works with respect to this Issue.

@Savio-Sou Savio-Sou changed the title Update the "Recursion on NoirJS" how-to guide Update the "Recursion on NoirJS" how-to guide with v0.26.0 example May 23, 2024
@Savio-Sou Savio-Sou changed the title Update the "Recursion on NoirJS" how-to guide with v0.26.0 example Bring nested recursion example into noir-lang/noir May 24, 2024
@Savio-Sou Savio-Sou added enhancement New feature or request CI labels May 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI documentation Improvements or additions to documentation enhancement New feature or request recursion Recursive proving / proof aggregation
Projects
Status: 🏗 In progress
Development

Successfully merging a pull request may close this issue.

2 participants