init repo, add initial structure
This commit is contained in:
commit
ceeddba2b5
15 changed files with 40 additions and 0 deletions
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
book
|
||||||
6
README.md
Normal file
6
README.md
Normal file
|
|
@ -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`
|
||||||
6
book.toml
Normal file
6
book.toml
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
[book]
|
||||||
|
authors = ["0xPARC"]
|
||||||
|
language = "en"
|
||||||
|
multilingual = false
|
||||||
|
src = "src"
|
||||||
|
title = "POD2-docs"
|
||||||
15
src/SUMMARY.md
Normal file
15
src/SUMMARY.md
Normal file
|
|
@ -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)
|
||||||
1
src/datatypes.md
Normal file
1
src/datatypes.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Data types
|
||||||
1
src/deductions.md
Normal file
1
src/deductions.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Deductions
|
||||||
2
src/examples.md
Normal file
2
src/examples.md
Normal file
|
|
@ -0,0 +1,2 @@
|
||||||
|
# Examples
|
||||||
|
> Examples of PODs at the conceptual level (ie. ZuKYC, ETHDos, etc).
|
||||||
1
src/introduction.md
Normal file
1
src/introduction.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Introduction
|
||||||
1
src/mainpod.md
Normal file
1
src/mainpod.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# MainPOD
|
||||||
1
src/merkletree.md
Normal file
1
src/merkletree.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# MerkleTree
|
||||||
1
src/mockpod.md
Normal file
1
src/mockpod.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# MockPOD
|
||||||
1
src/operations.md
Normal file
1
src/operations.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Operations
|
||||||
1
src/podtypes.md
Normal file
1
src/podtypes.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# POD types
|
||||||
1
src/signedpod.md
Normal file
1
src/signedpod.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# SignedPOD
|
||||||
1
src/statements.md
Normal file
1
src/statements.md
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
# Statements
|
||||||
Loading…
Add table
Add a link
Reference in a new issue