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: updating the noirjs tutorial to match stable + some other improvements #3929

Merged
merged 5 commits into from
Jan 5, 2024

Conversation

signorecello
Copy link
Contributor

Description

This PR updates the NoirJS tutorial and adds some other improvements.

Problem*

It wasn't too critical, but the NoirJS tutorial was a bit outdated.

Summary*

I picked on this task on my way towards documenting oracles. Summary of changes:

  • Bumped versions
  • Removed the yarn option for the sake of simplicity (inspired by ignore options and alternatives in Diátaxis framework)
  • Made the tutorial look like an app with some inputs and interactiveness (also inspired by Diátaxis
  • Ditched the convoluted rollup-copy and makeshift vite plugin in favour of a painless setup phase to init the wasms instead, this way we can use npm create vite and basically forget vite.
  • Added some memes

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

github-actions bot commented Jan 2, 2024

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.

Looks good, working smooth for me! Just some minor nits

docs/docs/tutorials/noirjs_app.md Show resolved Hide resolved
docs/docs/tutorials/noirjs_app.md Show resolved Hide resolved
docs/docs/tutorials/noirjs_app.md Outdated Show resolved Hide resolved
docs/docs/tutorials/noirjs_app.md Outdated Show resolved Hide resolved
docs/docs/tutorials/noirjs_app.md Outdated Show resolved Hide resolved
@TomAFrench TomAFrench changed the title fix: updating the noirjs tutorial to match stable + some other improvements chore: updating the noirjs tutorial to match stable + some other improvements Jan 4, 2024
@signorecello signorecello added this pull request to the merge queue Jan 5, 2024
Merged via the queue into master with commit c8bfa72 Jan 5, 2024
30 checks passed
@signorecello signorecello deleted the zpedro/tutorial_update branch January 5, 2024 15:21
TomAFrench added a commit that referenced this pull request Jan 8, 2024
* master:
  chore: Stop cloning `FuncMeta` (#3968)
  feat: add MVP `nargo export` command (#3870)
  chore: clippy and general cleanup of debugger (#3957)
  chore: updating the noirjs tutorial to match stable + some other improvements (#3929)
  chore: add `insert_range_check` method to `FunctionBuilder` (#3959)
  chore: remove usage of term "preprocessed" in favour of "artifact" (#3939)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants