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): More acir docs #7731

Merged
merged 9 commits into from
Mar 18, 2025
Merged

chore(docs): More acir docs #7731

merged 9 commits into from
Mar 18, 2025

Conversation

vezenovm
Copy link
Contributor

@vezenovm vezenovm commented Mar 17, 2025

Description

Problem*

Part of general documentation effort

Summary*

I simplified the README for the acir crate to only include the ACIR summary. I am leaning into specific opcode information should be declared within the code and generated using rustdocs.

I will do similar things in follow-up work for Brillig.

Additional Context

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.

@vezenovm vezenovm marked this pull request as ready for review March 18, 2025 15:58
@TomAFrench TomAFrench added this pull request to the merge queue Mar 18, 2025
Merged via the queue into master with commit 5f1bef0 Mar 18, 2025
108 checks passed
@TomAFrench TomAFrench deleted the mv/more-acir-docs branch March 18, 2025 16:42
aakoshh added a commit to AztecProtocol/aztec-packages that referenced this pull request Mar 19, 2025
Automated pull of nightly from the
[noir](https://github.com/noir-lang/noir) programming language, a
dependency of Aztec.
BEGIN_COMMIT_OVERRIDE
chore: add `mapi`/`for_eachi` functions
(noir-lang/noir#7705)
fix: Experiment with `DecrementRc`
(noir-lang/noir#7629)
chore: delete honk programs from `test_programs`
(noir-lang/noir#7727)
chore(docs): Landing page jargonless intro
(noir-lang/noir#7649)
chore(docs): More acir docs
(noir-lang/noir#7731)
chore: add extra docs lint (noir-lang/noir#7742)
fix: Fix stdout testing when running test programs
(noir-lang/noir#7741)
chore(ci): enforce rustdoc lints
(noir-lang/noir#7738)
chore: bump bb (noir-lang/noir#7726)
fix: handle predicate value reduction in array get also for the databus
(noir-lang/noir#7730)
chore(refactor): Move resolved error structures out of acir crate
(noir-lang/noir#7734)
chore(ci): private-kernel-inner timeout bump
(noir-lang/noir#7732)
END_COMMIT_OVERRIDE

---------

Co-authored-by: aakoshh <akosh@aztecprotocol.com>
Co-authored-by: Akosh Farkash <aakoshh@gmail.com>
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.

2 participants