Skip to content

Commit 60e2958

Browse files
authored
docs: Finalized Airbender documentation (#143)
## What ❔ <!-- What are the changes this PR brings about? --> <!-- Example: This PR adds a PR template to the repo. --> <!-- (For bigger PRs adding more context is appreciated) --> ## Why ❔ <!-- Why are these changes done? What goal do they contribute to? What are the principles behind them? --> <!-- The `Why` has to be clear to non-Matter Labs entities running their own ZK Chain --> <!-- Example: PR templates ensure PR reviewers, observers, and future iterators are in context about the evolution of repos. --> ## Is this a breaking change? - [ ] Yes - [x] No ## Checklist <!-- Check your PR fulfills the following items. --> <!-- For draft PRs check the boxes as you complete them. --> - [x] PR title corresponds to the body of PR (we generate changelog entries from PRs). - [ ] Tests for the changes have been added / updated. - [x] Documentation comments have been added / updated. - [x] Code has been formatted.
1 parent a3c7404 commit 60e2958

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+2085
-686
lines changed

.github/workflows/test-gpu.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ jobs:
7373
strategy:
7474
matrix:
7575
cuda: [ "12.9.1-devel-ubuntu22.04" ]
76-
# TODO: CUDA 13.0.0 is not yet supported by matterlabs-ci-gpu-runner.
76+
#CUDA 13.0.0 is not yet supported by matterlabs-ci-gpu-runner.
7777
package: [ "zksmith" ]
7878

7979
needs: zksync-airbender-build

NOTICE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ Substantial modifications have been made; see per‑file headers and git history
3131
1. <https://github.com/ingonyama-zk/papers/blob/main/Mersenne31_polynomial_arithmetic.pdf>
3232
2. <https://eprint.iacr.org/2023/824.pdf> (circle group LDE with compression)
3333
3. <https://www.robinscheibler.org/2013/02/13/real-fft.html> (Two for one FFT)
34-
4. [Our NTT math overview](../gpu_prover/src/ntt/two-for-one.pdf)
34+
4. [Our NTT math overview](gpu_prover/src/ntt/two-for-one.pdf)
3535
5. <https://eprint.iacr.org/2023/1115> (Memory: Two shuffles make a RAM)
3636

README.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,22 @@ This repository contains the RISC-V compilation and proving tools for the ZKsync
99
The most recent documentation can be found here:
1010

1111
- [In-repo docs](./docs/README.md)
12+
- [Overview](./docs/overview.md)
13+
- [Writing Programs](./docs/writing_programs.md)
1214
- [RISC-V Prover - Tutorial](./docs/tutorial.md)
13-
- [Philosophy and logic](./docs/philosophy_and_logic.md)
14-
- [Subarguments used](./docs/subarguments_used.md)
15+
- [End-to-End Guide](./docs/end_to_end.md)
16+
- [Philosophy and Logic](./docs/philosophy_and_logic.md)
17+
- [Circuit Overview](./docs/circuit_overview.md)
18+
- [Machine Configuration](./docs/machine_configuration.md)
19+
- [Delegation Circuits](./docs/delegation_circuits.md)
20+
- [AIR-style Constraints](./docs/air_constraints.md)
21+
- [Instruction Gadgets](./docs/instruction_gadgets.md)
22+
- [Circuit Entry Points](./docs/circuit_entry_points.md)
23+
- [Subarguments Used](./docs/subarguments_used.md)
1524
- [Code Repository Layout](./docs/repo_layout.md)
25+
- [RISC-V Simulator - Supported Instructions](./docs/simulator_supported_instructions.md)
26+
- [GPU Acceleration](./docs/gpu.md)
27+
- [Test Suites](./docs/tests_overview.md)
1628

1729
## How to run it
1830

@@ -48,7 +60,7 @@ Details on third-party notices can be found in [NOTICE.md](./NOTICE.md), in `ACK
4860
- [Twitter for Developers](https://twitter.com/zkSyncDevs)
4961
- [Discord](https://join.zksync.dev/)
5062
- [Mirror](https://zksync.mirror.xyz/)
51-
- [Youtube](https://www.youtube.com/@zkSync-era)
63+
- [YouTube](https://www.youtube.com/@zkSync-era)
5264

5365
## Contribution
5466

1.31 MB
Binary file not shown.

0 commit comments

Comments
 (0)