chore(docs): Reorder tooling docs by Savio-Sou · Pull Request #8742 · noir-lang/noir

Savio-Sou · 2025-05-30T20:58:39Z

Description

Changelog*

On main docs:

Relocate the content of the "Security checks" page introduced in chore: Add SSA security checks description #7366 into the "Unconstrained Functions" page, as they are all safety checks on unconstrained functions
Rename the "Testing in Noir" page to "Tests" for consistency
Rename the "Noir Fuzzer" page to "Fuzzer" + rename paths for consistency
Fix sidebar positions

On versioned docs:

Copy fuzzer renames (i.e. number 3 above) into versioned docs

Additional Context

Improvements from reviewing docs of v1.0.0-beta.4 and preparing its release.

Documentation*

Check one:

No documentation needed.
Documentation included in this PR.
[For Experimental Features] 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.

… page

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Test Suite Duration'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite	Current: `febdbb6`	Previous: `c2cedd4`	Ratio
`test_report_zkpassport_noir_rsa_`	`2` s	`1` s	`2`

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

github-actions

⚠️ Performance Alert ⚠️

Possible performance regression was detected for benchmark 'Execution Time'.
Benchmark result of this commit is worse than the previous benchmark result exceeding threshold 1.20.

Benchmark suite	Current: `ba5c84c`	Previous: `8598eab`	Ratio
`rollup-merge`	`0.004` s	`0.003` s	`1.33`

This comment was automatically generated by workflow using github-action-benchmark.

CC: @TomAFrench

github-actions · 2025-06-06T16:11:51Z

🚀 Deployed on https://6843133c41f0e378d4e867e0--noir-docs.netlify.app

github-actions · 2025-06-06T16:12:13Z

FYI @noir-lang/developerrelations on Noir doc changes.

Automated pull of nightly from the [noir](https://github.com/noir-lang/noir) programming language, a dependency of Aztec. BEGIN_COMMIT_OVERRIDE chore(docs): Update noirjs app page to use to beta.6 (noir-lang/noir#8853) fix: support recursive call to main function in SSA parser (noir-lang/noir#8760) chore(SSA): validate that constrain values have the same type (noir-lang/noir#8850) fix: Comptime field division should error when the rhs is zero (noir-lang/noir#8845) chore: redo typo PR by osrm (noir-lang/noir#8840) fix: (SSA interpreter) to_le_bits returns [u1; _], not [u8; _] (noir-lang/noir#8837) chore(ssa): Initial validation module (noir-lang/noir#8765) chore: bump external pinned commits (noir-lang/noir#8834) feat(fuzz): Generate arbitrary constraints (noir-lang/noir#8820) fix: bind self generic type in trait calls via a concrete type in more cases (noir-lang/noir#8827) fix(comptime): Overflow on shl (noir-lang/noir#8829) fix(interpreter): Return -1 for negative shr signed overflow or 0 for positive shr signed overflow (noir-lang/noir#8828) feat(ssa_fuzzer): branching + constrains (noir-lang/noir#8599) chore(docs): Add experimental warning in Debugger docs (noir-lang/noir#8824) fix: Thread errors through remove_if_else instead of panicing when the value merger finds reference values (noir-lang/noir#8783) fix(interpreter): Do not overflow on signed checked ops (noir-lang/noir#8806) feat: short circuit creation of `Type::InfixExpr` containing errors (noir-lang/noir#8826) fix(mem2reg): Keep last stores used in array returned from a function (noir-lang/noir#8801) chore(ci): `cargo clippy` CI script to save time (noir-lang/noir#8787) chore: only follow bindings on interface to `arithmetic` module (noir-lang/noir#8822) fix: bind self generic type in trait calls via a concrete type (noir-lang/noir#8825) chore(docs): Reorder tooling docs (noir-lang/noir#8742) chore: small fix for outdated docs (noir-lang/noir#8821) fix(mem2reg): Keep last stores used in MakeArray (noir-lang/noir#8743) fix!: Error when re-assigning a mutable reference (noir-lang/noir#8790) fix!: indexing arrays with non-u32 is now an error (noir-lang/noir#8804) fix: signed right shift overflows to 0 or -1 (noir-lang/noir#8805) chore(fuzz): Tool to minimize Noir programs with `cvise` (noir-lang/noir#8789) END_COMMIT_OVERRIDE --------- Co-authored-by: AztecBot <tech@aztecprotocol.com> Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>

Savio-Sou added 8 commits May 30, 2025 16:11

Merge unconstrained security check docs into unconstrained functions'…

6ab69c0

… page

Rename testing doc page

4d80d8e

Rename fuzzer doc page

84cfdee

Fix tooling doc page ordering

d2a4cb2

Align mentions of Nargo

d7d619f

Fix references

a5329bd

Rename fuzzer static image path

3d60ab6

Copy fuzzer doc page rename into versioned docs

e83b96a

Savio-Sou added this to Noir May 30, 2025

Savio-Sou added the documentation Improvements or additions to documentation label May 30, 2025

github-project-automation bot moved this to 📋 Backlog in Noir May 30, 2025

Savio-Sou moved this from 📋 Backlog to 🏗 In progress in Noir May 30, 2025

Savio-Sou requested a review from rkarabut June 3, 2025 15:54

rkarabut approved these changes Jun 3, 2025

View reviewed changes

Savio-Sou enabled auto-merge June 5, 2025 21:35

Merge branch 'master' into ss/reorder-tooling-docs

65caf91

Savio-Sou disabled auto-merge June 5, 2025 21:43

Fix beta.4 folder naming

febdbb6

Savio-Sou enabled auto-merge June 5, 2025 21:49

github-actions bot reviewed Jun 5, 2025

View reviewed changes

Savio-Sou added 4 commits June 6, 2025 23:59

Merge branch 'master' into ss/reorder-tooling-docs

5b56bbd

Fix links to Fuzzer page

341153d

Fix links to Tests page

f0df32a

Fix link to Tests page

ba5c84c

github-actions bot reviewed Jun 6, 2025

View reviewed changes

Fix links to Tests page

3041be4

Savio-Sou added this pull request to the merge queue Jun 6, 2025

Merged via the queue into master with commit 2e5cd41 Jun 6, 2025
116 of 117 checks passed

Savio-Sou deleted the ss/reorder-tooling-docs branch June 6, 2025 16:37

github-project-automation bot moved this from 🏗 In progress to ✅ Done in Noir Jun 6, 2025

AztecBot mentioned this pull request Jun 7, 2025

chore: Bump Noir reference AztecProtocol/aztec-packages#14878

Merged

AztecBot mentioned this pull request Jun 10, 2025

chore(next): release 0.88.0 AztecProtocol/aztec-packages#14495

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(docs): Reorder tooling docs#8742

chore(docs): Reorder tooling docs#8742
Savio-Sou merged 15 commits intomasterfrom
ss/reorder-tooling-docs

Savio-Sou commented May 30, 2025 •

edited

Loading

Uh oh!

github-actions bot left a comment

Uh oh!

github-actions bot left a comment

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Savio-Sou commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Changelog*

Additional Context

Documentation*

PR Checklist*

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

Uh oh!

github-actions bot left a comment

Choose a reason for hiding this comment

⚠️ Performance Alert ⚠️

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

github-actions bot commented Jun 6, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Savio-Sou commented May 30, 2025 •

edited

Loading