commit ceeddba2b5842a6f231098a7ccdf382c3e262b98 Author: arnaucube Date: Thu Jan 30 17:32:09 2025 +0100 init repo, add initial structure diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..7585238 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +book diff --git a/README.md b/README.md new file mode 100644 index 0000000..b07f60b --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# pod2-docs +> Hackmds for sharing ideas, once there is consensus around it, move it into this repo to consolidate it. Also we can use PRs to discuss asynchronously specific ideas of the spec. + +## Usage +- Needs [mdbook](https://github.com/rust-lang/mdBook), to install: `cargo install mdbook` +- Run locally: `mdbook serve` diff --git a/book.toml b/book.toml new file mode 100644 index 0000000..e17c20c --- /dev/null +++ b/book.toml @@ -0,0 +1,6 @@ +[book] +authors = ["0xPARC"] +language = "en" +multilingual = false +src = "src" +title = "POD2-docs" diff --git a/src/SUMMARY.md b/src/SUMMARY.md new file mode 100644 index 0000000..dc5cea4 --- /dev/null +++ b/src/SUMMARY.md @@ -0,0 +1,15 @@ +# Summary + +- [Introduction](./introduction.md) + +# Specification +- [Data types](./datatypes.md) + - [MerkleTree](./merkletree.md) +- [Deductions](./deductions.md) + - [Statements](./statements.md) + - [Operations](./operations.md) +- [POD types](./podtypes.md) + - [SignedPOD](./signedpod.md) + - [MainPOD](./mainpod.md) + - [MockPOD](./mockpod.md) +- [Examples](./examples.md) diff --git a/src/datatypes.md b/src/datatypes.md new file mode 100644 index 0000000..7c33623 --- /dev/null +++ b/src/datatypes.md @@ -0,0 +1 @@ +# Data types diff --git a/src/deductions.md b/src/deductions.md new file mode 100644 index 0000000..07360ab --- /dev/null +++ b/src/deductions.md @@ -0,0 +1 @@ +# Deductions diff --git a/src/examples.md b/src/examples.md new file mode 100644 index 0000000..fa8f26e --- /dev/null +++ b/src/examples.md @@ -0,0 +1,2 @@ +# Examples +> Examples of PODs at the conceptual level (ie. ZuKYC, ETHDos, etc). diff --git a/src/introduction.md b/src/introduction.md new file mode 100644 index 0000000..e10b99d --- /dev/null +++ b/src/introduction.md @@ -0,0 +1 @@ +# Introduction diff --git a/src/mainpod.md b/src/mainpod.md new file mode 100644 index 0000000..bb64e8f --- /dev/null +++ b/src/mainpod.md @@ -0,0 +1 @@ +# MainPOD diff --git a/src/merkletree.md b/src/merkletree.md new file mode 100644 index 0000000..0696c74 --- /dev/null +++ b/src/merkletree.md @@ -0,0 +1 @@ +# MerkleTree diff --git a/src/mockpod.md b/src/mockpod.md new file mode 100644 index 0000000..050e8ad --- /dev/null +++ b/src/mockpod.md @@ -0,0 +1 @@ +# MockPOD diff --git a/src/operations.md b/src/operations.md new file mode 100644 index 0000000..114493d --- /dev/null +++ b/src/operations.md @@ -0,0 +1 @@ +# Operations diff --git a/src/podtypes.md b/src/podtypes.md new file mode 100644 index 0000000..2d911ef --- /dev/null +++ b/src/podtypes.md @@ -0,0 +1 @@ +# POD types diff --git a/src/signedpod.md b/src/signedpod.md new file mode 100644 index 0000000..067003c --- /dev/null +++ b/src/signedpod.md @@ -0,0 +1 @@ +# SignedPOD diff --git a/src/statements.md b/src/statements.md new file mode 100644 index 0000000..8ecfe68 --- /dev/null +++ b/src/statements.md @@ -0,0 +1 @@ +# Statements