proto-kit / website

MIT License
2 stars 5 forks source link

Create docs for Protokit #1

Closed rpanic closed 8 months ago

rpanic commented 12 months ago

This PR set's up and fills the docs page for protokit, to be used as a reference by builders

Preliminary docs structure

Home
What is Protokit?
    Overview
    Protokit vs. XProtokit vs. X
    Vision
    Roadmap
    How to participate?

**Developer Documentation**

Getting started
    Quickstart
    Walkthrough (basic example from A->Z using starter kit)
Building provable code
    o1js Basics
    Do's and Dont's (alternative: Provable vs. Non-Provable)
    Advanced o1js concepts
Basics
    Structure
    Storage
    Data Types (X)
    Writing Functions (runtime function, parameters, assertions)
    Composing Modules
    Off-Chain execution for Protokit (describe how to use ZkProgram with Proofs as Argument)
Testing
Running
    Quick spinup
    Modularity
    Components (Sequencer, Protocol, Runtime)
    Graphql
Writing UIs
    Client Appchain (connection via GQL, Query)
    Starter-kit using NextJS
Advanced
    Customize the Protocol (Protocol modules)
    State Proofs (X)
    (future) Integrate Smart Contracts into your appchain
    (future) Data availability modes
    (future) Mempool modes, Interop modes

Tutorials
    Private Airdrop

**Concepts**

Foundational Concepts
    State Model
    Linked Merkle Tree

Advanced Concepts
    Prover Architecture

**Other**
What's new in Protokit
netlify[bot] commented 12 months ago

Deploy Preview for aesthetic-beijinho-ea3a52 ready!

Name Link
Latest commit
Latest deploy log https://app.netlify.com/sites/aesthetic-beijinho-ea3a52/deploys/6596aae9058c5a0cf9cb3c3c
Deploy Preview https://deploy-preview-1--aesthetic-beijinho-ea3a52.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.