You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat(docs): Add docusaurus plugin to autogerate llms.txt (#16362)
Adds a plugin to the docs to autogenerate an llms.txt file and an
llms-full.txt file to be published with the docs site according to the
standards defined at https://llmstxt.org/.
Also adds page descriptions to pages that are missing them, since this
helps with generating the llms.txt.
Note that this is set up to generate the file for the first versioned
defined in the versions.json file, which should be the default version
for the docs site.
Also removes an outdated sandbox features page.
closes: AztecProtocol/dev-rel#597
Copy file name to clipboardExpand all lines: docs/docs/aztec/concepts/accounts/index.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
title: Accounts
3
3
sidebar_position: 1
4
4
tags: [accounts]
5
+
description: Learn about Aztec's native account abstraction, where every account is a smart contract, and how wallets interact with account contracts for authentication and transaction execution.
5
6
---
6
7
7
8
Aztec has native account abstraction. Every account in Aztec is a smart contract.
Copy file name to clipboardExpand all lines: docs/docs/aztec/concepts/accounts/keys.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
title: Keys
3
3
tags: [accounts, keys]
4
+
description: Understand the key pairs used in Aztec accounts - nullifier keys, address keys, incoming viewing keys, and signing keys - and how they enable privacy and authentication.
description: Learn about Aztec's Authentication Witness scheme that enables secure third-party actions on behalf of users, providing a privacy-preserving alternative to traditional token approvals.
Copy file name to clipboardExpand all lines: docs/docs/aztec/concepts/advanced/circuits/index.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
title: Circuits
3
3
sidebar_position: 2
4
4
tags: [protocol, circuits]
5
+
description: Explore Aztec's core protocol circuits that enforce privacy rules and transaction validity through zero-knowledge proofs, enabling private state and function execution.
5
6
---
6
7
7
8
Central to Aztec's operations are 'circuits' derived both from the core protocol and the developer-written Aztec.nr contracts.
Copy file name to clipboardExpand all lines: docs/docs/aztec/concepts/advanced/circuits/kernels/private_kernel.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
title: Private Kernel Circuit
3
3
tags: [protocol, circuits]
4
+
description: Learn about the Private Kernel Circuit, the only zero-knowledge circuit in Aztec that handles private data and ensures transaction privacy by executing on user devices.
4
5
---
5
6
6
7
This circuit is executed by the user, on their own device. This is to ensure private inputs to the circuit remain private!
description: Understand the Public Kernel Circuit executed by sequencers that manages public state transitions in Aztec.
4
5
---
5
6
6
7
This circuit is executed by a Sequencer, since only a Sequencer knows the current state of the [public data tree](../../../storage/state_model.md#public-state) at any time. A Sequencer might choose to delegate proof generation to the Prover pool.
Copy file name to clipboardExpand all lines: docs/docs/aztec/concepts/advanced/circuits/rollup_circuits/index.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,7 @@
1
1
---
2
2
title: Rollup Circuits
3
3
tags: [protocol, circuits]
4
+
description: Learn how Rollup Circuits compress thousands of transactions into a single SNARK proof using a binary tree topology for efficient verification on Ethereum.
4
5
---
5
6
6
7
The primary purpose of the Rollup Circuits is to 'squish' all of the many thousands of transactions in a rollup into a single SNARK, which can then be efficiently and verified on Ethereum.
Copy file name to clipboardExpand all lines: docs/docs/aztec/concepts/advanced/index.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
title: Advanced Concepts
3
3
sidebar_position: 9
4
4
tags: [protocol]
5
+
description: Explore advanced concepts of the Aztec Network including authentication witnesses and other protocol-level details for experienced developers.
5
6
---
6
7
7
8
In this section, you'll learn about the more advanced concepts of the Aztec Network. It is not required to understand these in order to start building on Aztec.
Copy file name to clipboardExpand all lines: docs/docs/aztec/concepts/advanced/storage/indexed_merkle_tree.mdx
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,7 @@
2
2
title: Indexed Merkle Tree (Nullifier Tree)
3
3
tags: [storage, concepts, advanced]
4
4
sidebar_position: 2
5
+
description: Learn about indexed merkle trees, an efficient data structure for nullifier trees that enables fast non-membership proofs and batch insertions in Aztec.
5
6
---
6
7
7
8
importImagefrom"@theme/IdealImage";
@@ -183,7 +184,7 @@ Suppose we want to show that the value `20` doesn't exist in the tree. We just r
183
184
- Prove the low leaf exists in the tree: `n` hashes.
184
185
- Check the new value 'would have' belonged in the range given by the low leaf: `2` range checks.
185
186
- If ($low\_nullifier_{\textsf{next\_index}} == 0$):
186
-
- Special case, the low leaf is at the very end, so the new\_value must be higher than all values in the tree:
187
+
- Special case, the low leaf is at the very end, so the new_value must be higher than all values in the tree:
0 commit comments