Stone book

[dmirgaleev]

What

Create a web portal containing links to the Stone prover binaries, packages, and Docker images for specific operating systems, as well as installation and usage instructions.

Why

Currently Stone binaries are available via releases/packages in this repository, while all the instructions are in the readme. It is not very convenient to navigate through and it would be great to have it all in one place, well structured, and with good navigation.

Similar situation is with the Stone itself: the only usage instruction available is in the main repo readme and it is incomplete: there many subtleties with regards to Cairo0/Cairo1, preparing prover config based on the trace length, choosing the right layout depending on which builtins you use, etc. Ideally we should have a comprehensive guide that covers most common use cases.

Lastly, there are several other sources of information regarding Stone and it would be great to maintain an aggregated list of links with a short description.

How

The website should be hosted on Github pages and the deployment has to be done via Github action on every git tag event. The documentation files should be in markdown.

Suggested portal structure:

├── Installation
│   ├── From sources
│   ├── Static binaries
│   ├── Docker images
│   └── Debian packages
├── Usage
│   ├── Generating execution artifacts
│   ├── Preparing prover arguments
│   ├── Proving execution
│   ├── Verifying proof
│   ├── Registering proof on Ethereum
│   └── Registering proof on Starknet
├── Advanced
│   ├── Builtins and layouts
│   ├── FRI protocol parameters
│   └── PIE format
├── Examples
│   ├── Fibonacci
│   └── etc
└── Links
    ├── [Madara Prover API](https://github.com/Moonsong-Labs/madara-prover-api)
    ├── [Stone Prover SDK](https://github.com/Moonsong-Labs/stone-prover-sdk)
    ├── [Stone CLI](https://github.com/zksecurity/stone-cli)
    ├── [STARK EVM Adapter](https://github.com/zksecurity/stark-evm-adapter)
    ├── [Integrity Calldata Generator](https://github.com/HerodotusDev/integrity-calldata-generator)
    └── https://github.com/cartridge-gg/cairo-proof-parser

Tasks

• [Book] Integrate Vocs framework  #21
• [Book] Install Stone from sources #22
• [Book] Install Stone binaries #23
• [Book] Install Stone Docker images #24
• [Book] Install Stone deb package #25
• [Book] Cairo execution artifacts #27
• [Book] Stone parameters #28
• [Book] Stone configuration #29
• [Book] Generating proof #30
• [Book] Verifying proof #31
• [Book] Examples #32
• [Book] Verifying Stone proof in Ethereum #34
• [Book] Verifying Stone proof on Starknet #35
• [Book] Links #36

[ScottyDavies]

Hello @dmirgaleev Please can you assign this task to me so I can start working on it immediately.

[KevinMB0220]

I am interested in contributing to the issue "Create documentation pages based on the README page." I plan to extract the most important sections from the README, such as installation, usage, and API details, and then structure them into dedicated documentation pages. My goal is to enhance the clarity and accessibility of the information, making it easier for users and developers to find what they need efficiently. I am confident that this approach will improve the overall user experience and maintain high-quality documentation standards. @dmirgaleev

[Mystic-Nayy]

@dmirgaleev I will like to work on this issue when ODHack starts
I am a web3 developer/Technical writer
i have a lot of experiences in writing Docs and readme,
here are some of the Docs i have witten for other projects
Flex-NFT-Marketplace/Flex-Marketplace-Contract@fc28412
paltalabs/create-soroban-dapp#27

[onlydustapp]

Hi @Gift-Naomi!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

[Jemiiah]

@dmirgaleev I would love to work on this issue during the next coming ODHack I have worked on about 6 different documentation issue on different repositories this is my OD Hack portfolio with over 50 contributions https://app.onlydust.com/u/Jemiiah I have a very good track record on docs issues here are some of the repositories I have worked on:
Flex-NFT-Marketplace/Flex-Marketplace-Contract#106
dragan2234/worldcoin-scroll-bridge#13
dragan2234/worldcoin-scroll-bridge#11
NethermindEth/StarknetByExample#200

[onlydustapp]

Hi @Jemiiah!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

[onlydustapp]

Hi @Jemiiah!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

[onlydustapp]

Hi @Jemiiah!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

[martinvibes]

hello @dmirgaleev please can i work on this issue :), i would love to be a contributor in this repo
i'm a frontend developer and a technical writer
i have written/worked on different documentations on different repositories

[onlydustapp]

Hi @martinvibes!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

[od-hunter]

Hi @dmirgaleev , can I be assigned this please?
I’m a blockchain developer and I’m also good with documentations. Below are some of my merged documentations:

dojoengine/book#308 (comment)

keep-starknet-strange/joyboy#143 (comment),

horuslabsio/Starknet-Scaffold#94 (comment).

please I’d love to be given the opportunity to contribute to this repo.

[onlydustapp]

Hi @od-hunter!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

[PavitraAgarwal21]

Hey Hi @dmirgaleev
I would really like to learn and understand this topic, as it will be useful for my project. Could you please assign this task to me? While I read and successfully apply it to my project, I will also write the documentation for it. I believe I am the right fit for this task.

[onlydustapp]

Hi @PavitraAgarwal21!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.

[onlydustapp]

Hi @vickiddev!
Maintainers during the ODHack # 8.0 will be tracking applications via OnlyDust.
Therefore, in order for you to have a chance at being assigned to this issue, please apply directly here, or else your application may not be considered.