diff --git a/README.md b/README.md index 17696c3..5bd7276 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ -# Aztec Protocol Documentation -You can view the latest successful build here. https://docs.aztec.network +# Aztec Network Documentation + +Documentation for the Aztec Network, built with docusaurus -Built with docusaurus. +You can view the latest successful build here. https://docs.aztec.network ## Files @@ -42,4 +43,4 @@ This command starts a local development server and opens up a browser window. Mo $ yarn build ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. \ No newline at end of file +This command generates static content into the `build` directory and can be served using any static contents hosting service. diff --git a/docs/what-is-aztec.md b/docs/what-is-aztec.md index 8c21061..5b7e4f5 100644 --- a/docs/what-is-aztec.md +++ b/docs/what-is-aztec.md @@ -2,16 +2,18 @@ title: What is Aztec? --- -Aztec is a Layer 2 zk-rollup, designed to enable programmable privacy, that will run on Ethereum. It will allow developers to build fully programable, privacy preserving smart contracts, with composable call semantics using our ZK-Snark programming language, [Noir](./noir). +Aztec is a Layer 2 ZK-rollup running on Ethereum, designed to enable programmable privacy. It allows developers to build fully-programable, privacy-preserving smart contracts, with composable call semantics using our ZK-Snark programming language: [Noir](./noir). **Why?** -A public blockchain utilizes a peer-to-peer network and a consensus protocol to establish the correct record of events. The core unit of intent (a transaction) is a request to update state, based on the logic of a predefined program. The blockchain node, computes this state update and records it on a shared ledger. The correctness of the ledger is enforced by other nodes "checking" the work of the current node -- only possible as the transactions and their data are public and visible to anyone. +Public blockchains utilize peer-to-peer networks and a consensus protocol to establish the correct record of events. +The core unit of intent (a transaction) is a request to update a state, based on the logic of a predefined program. +The blockchain node computes this state update and records it on a shared ledger. The authenticity of the ledger is enforced by other nodes "checking" the work of the current node — only possible if the transactions and their data are public and visible to anyone. -Ethereum is an example of a public blockchain, that enables the processing of transactions with arbitrary, Turing complete computation. +Ethereum is an example of a public blockchain, and enables the processing of transactions with arbitrary, Turing-complete computation. -**Aztec is an encrypted blockchain**, where the core unit of intent is a zero-knowledge proof, not a transaction request. The zero-knowledge proof, proves the correct execution of a specific transaction and any resultant state updates. +**Aztec is an encrypted blockchain**, where the core unit of intent is a Zero-Knowledge proof (ZKP), not a transaction request. The ZKP proves the correct execution of a specific transaction and any resultant state update. -Individual transaction proofs are recursively aggregated or "rolled up" using a zk-rollup construction, for final verification on Ethereum. +Individual transaction proofs are recursively aggregated or "rolled up" using a ZK-rollup construction, used for final verification on Ethereum. To read more about the network, how it works, and the types of applications that can be built, head to Aztec's Architecture [here](./aztec/overview). diff --git a/docusaurus.config.js b/docusaurus.config.js index 94f0d50..491a458 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -40,7 +40,7 @@ const config = { ({ docs: { sidebarPath: require.resolve("./sidebars.js"), - editUrl: "https://github.com/AztecProtocol/docs/edit/main/", + editUrl: "https://github.com/AztecProtocol/docs/edit/pre-sandbox-docs/", routeBasePath: "/", remarkPlugins: [math], rehypePlugins: [katex], diff --git a/src/css/custom.css b/src/css/custom.css index 1207752..dfd3873 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -64,4 +64,4 @@ @font-face { font-family: 'Plain-Regular'; src: url('../../static/font/Plain-Regular.otf'); -} \ No newline at end of file +}