Skip to content

Commit

Permalink
docs: fix bad shareable key crypto. better explanations (#3228)
Browse files Browse the repository at this point in the history
Removing an incorrect shareable key scheme.
Add lots of exposition around requirements that haven't-yet been solved.
Add diagrams
Rearranging things.
Explain proof of correct ovsk and ask in an app circuit (via the kernel
circuit).
  • Loading branch information
iAmMichaelConnor authored Nov 3, 2023
1 parent d707d4e commit e4a0c4a
Show file tree
Hide file tree
Showing 11 changed files with 442 additions and 406 deletions.
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,8 @@
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
// Now when a new file is pasted in /yellow-paper/docs/readme.md, the image file is created at /yellow-paper/docs/images/readme/image.png.
"markdown.copyFiles.destination": {"/yellow-paper/**/*": "images/${documentBaseName}/"},
///////////////////////////////////////
// C++/Circuits settings
///////////////////////////////////////
Expand Down
791 changes: 405 additions & 386 deletions yellow-paper/docs/addresses-and-keys/addresses-and-keys.md

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion yellow-paper/docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sidebar_position: 1
---

# About
# Editorial guidelines

This "yellow paper" is a first attempt to describe the Aztec protocol in its entirety.

Expand Down Expand Up @@ -98,6 +98,8 @@ The draft subsections are mere suggestions (and serve as a helpful reminder of t
- Block hashes tree
- Tree Epochs
- L1 State [Lasse]
- Contract State
- Transactions
- Bytecode [Alvaro]
- ACIR
- Encodings
Expand Down
44 changes: 27 additions & 17 deletions yellow-paper/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ let macros = {};

/** @type {import('@docusaurus/types').Config} */
const config = {
title: "Aztec Yellow Paper",
tagline: "Aztec Network Specification",
favicon: "img/favicon.ico",
title: "Aztec Protocol Description",
tagline: "The Aztec Protocol, described.",
// favicon: "img/favicon.ico",

// Set the production url of your site here
url: "https://your-docusaurus-test-site.com",
Expand All @@ -22,8 +22,8 @@ const config = {

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: "Aztec Labs", // Usually your GitHub org/user name.
projectName: "Aztec Yellow Paper", // Usually your repo name.
organizationName: "AztecProtocol", // Usually your GitHub org/user name.
projectName: "aztec-packages", // Usually your repo name.

onBrokenLinks: "throw",
onBrokenMarkdownLinks: "warn",
Expand Down Expand Up @@ -80,22 +80,22 @@ const config = {
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
({
// Replace with your project's social card
image: "img/docusaurus-social-card.jpg",
// image: "img/docusaurus-social-card.jpg",
navbar: {
title: "My Site",
logo: {
alt: "My Site Logo",
src: "img/logo.svg",
},
title: "Home",
// logo: {
// alt: "My Site Logo",
// src: "img/logo.svg",
// },
items: [
{
type: "docSidebar",
sidebarId: "tutorialSidebar",
position: "left",
label: "Tutorial",
label: "Protocol Description",
},
{
href: "https://github.com/facebook/docusaurus",
href: "https://github.com/AztecProtocol/aztec-packages",
label: "GitHub",
position: "right",
},
Expand All @@ -106,18 +106,28 @@ const config = {
links: [
{
title: "Docs",
items: [],
items: [
{
label: "Docs",
href: "https://docs.aztec.network",
},
],
},
{
title: "Community",
items: [],
title: "Forum",
items: [
{
label: "Forum",
href: "https://forum.aztec.network",
},
],
},
{
title: "More",
items: [
{
label: "GitHub",
href: "https://github.com/facebook/docusaurus",
href: "https://github.com/AztecProtocol/aztec-packages",
},
],
},
Expand Down
6 changes: 4 additions & 2 deletions yellow-paper/src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ function HomepageHeader() {
<Link
className="button button--secondary button--lg"
to="/docs/intro">
Docusaurus Tutorial - 5min ⏱️
Read now
</Link>
</div>
</div>
Expand All @@ -33,9 +33,11 @@ export default function Home(): JSX.Element {
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
<HomepageHeader />

{/* TODO: put some pretty content in here:
<main>
<HomepageFeatures />
</main>
</main> */}
</Layout>
);
}
1 change: 1 addition & 0 deletions yellow-paper/static/img/DO_NOT_USE.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Instead, pics will be auto-pasted into an `images` subdir of any doc that you paste an image into.

0 comments on commit e4a0c4a

Please sign in to comment.