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): Rearrange NoirJS section #3260

Merged
merged 2 commits into from
Oct 24, 2023
Merged

chore(docs): Rearrange NoirJS section #3260

merged 2 commits into from
Oct 24, 2023

Conversation

Savio-Sou
Copy link
Collaborator

Description

Summary*

Minor rearrangements of the NoirJS documentation section in preparation of the NoirJS public launch:

  • Rename all "Noir JS" into "NoirJS"
  • Add installation instructions on the main NoirJS page
  • Rename the app guide page to "End-to-end"
  • Move the "Reference" section to after "Guides" as people would likely prefer reading in that order
  • Move the "Reference - BarretenbergBackend" section to after "Reference - Noir" as people would likely prefer reading in that order
  • Prettier's auto formatting changes

PR Checklist*

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

@Savio-Sou Savio-Sou added the documentation Improvements or additions to documentation label Oct 23, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Oct 23, 2023

It's Alive!

I'm a bot, beep boop 🤖

Deployment Status: Success!

Netlify Status

Preview

🌐 View Deployment Preview

@Savio-Sou Savio-Sou added this pull request to the merge queue Oct 24, 2023
Merged via the queue into master with commit 031bd4d Oct 24, 2023
33 checks passed
@Savio-Sou Savio-Sou deleted the ss/docs-noir-js branch October 24, 2023 10:44
TomAFrench added a commit that referenced this pull request Oct 24, 2023
* master:
  chore(docs): Rearrange NoirJS section (#3260)
  chore(docs): Document `nargo fmt` (#3262)
  feat(debugger): Print limited source code context (#3217)
  fix: recompile artefacts from a different noir version (#3248)
  chore: Update ACIR artifacts (#3263)
  fix: Show println output before an error occurs in `nargo execute` (#3211)
  chore(docs): document info codelens (#3252)
  fix: Impl methods are no longer placed in contracts (#3255)
  feat(stdlib): optimize constraint counts in sha256/sha512 (#3253)
  chore: enhance code formatting for If expressions (#3246)
  feat: Cache debug artifacts  (#3133)
TomAFrench added a commit that referenced this pull request Oct 24, 2023
* master:
  chore(docs): Rearrange NoirJS section (#3260)
  chore(docs): Document `nargo fmt` (#3262)
  feat(debugger): Print limited source code context (#3217)
  fix: recompile artefacts from a different noir version (#3248)
  chore: Update ACIR artifacts (#3263)
  fix: Show println output before an error occurs in `nargo execute` (#3211)
  chore(docs): document info codelens (#3252)
  fix: Impl methods are no longer placed in contracts (#3255)
  feat(stdlib): optimize constraint counts in sha256/sha512 (#3253)
  chore: enhance code formatting for If expressions (#3246)
  feat: Cache debug artifacts  (#3133)
TomAFrench added a commit that referenced this pull request Oct 24, 2023
* master:
  feat: implement euclidean division and signed division in terms of `AcirVar`s (#3230)
  feat: replace boolean range constraints with arithmetic opcodes (#3234)
  feat!: Switch to new pedersen implementation (#3151)
  feat: noir-wasm takes dependency graph (#3213)
  chore(docs): Rearrange NoirJS section (#3260)
  chore(docs): Document `nargo fmt` (#3262)
  feat(debugger): Print limited source code context (#3217)
  fix: recompile artefacts from a different noir version (#3248)
  chore: Update ACIR artifacts (#3263)
  fix: Show println output before an error occurs in `nargo execute` (#3211)
  chore(docs): document info codelens (#3252)
  fix: Impl methods are no longer placed in contracts (#3255)
  feat(stdlib): optimize constraint counts in sha256/sha512 (#3253)
  chore: enhance code formatting for If expressions (#3246)
  feat: Cache debug artifacts  (#3133)
TomAFrench added a commit that referenced this pull request Oct 24, 2023
* master:
  feat: implement euclidean division and signed division in terms of `AcirVar`s (#3230)
  feat: replace boolean range constraints with arithmetic opcodes (#3234)
  feat!: Switch to new pedersen implementation (#3151)
  feat: noir-wasm takes dependency graph (#3213)
  chore(docs): Rearrange NoirJS section (#3260)
  chore(docs): Document `nargo fmt` (#3262)
  feat(debugger): Print limited source code context (#3217)
  fix: recompile artefacts from a different noir version (#3248)
  chore: Update ACIR artifacts (#3263)
  fix: Show println output before an error occurs in `nargo execute` (#3211)
  chore(docs): document info codelens (#3252)
  fix: Impl methods are no longer placed in contracts (#3255)
  feat(stdlib): optimize constraint counts in sha256/sha512 (#3253)
  chore: enhance code formatting for If expressions (#3246)
  feat: Cache debug artifacts  (#3133)
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