search

dipdup-io / stone-packaging

Various forms of distribution for the Starkware Stone prover and verifier
https://stone-packaging.pages.dev
MIT License
16 stars 28 forks source link

[Book] Examples #32

Open dmirgaleev opened 1 month ago

dmirgaleev commented 1 month ago

Add a documentation page containing a list of reference test files, namely:

It also has to contain a brief description of what the program does, its arguments (if applicable).

Path to your markdown file: docs/pages/examples.md

References:

raizo07 commented 1 month ago

Can I work on this

onlydustapp[bot] commented 1 month ago

Hi @raizo07! 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 commented 1 month ago

hello @dmirgaleev i am a blockchain developer and a technical writer please can i work on this issue :) and would love to be a contributor

here are some of the docs i have writting: https://github.com/cairo-book/cairo-book/blob/main/src/ch16-05-01-price-feeds.md https://github.com/bandada-infra/bandada/blob/main/README.md https://github.com/lfglabs-dev/starknet.quest/blob/testnet/docs/CONTRIBUTING.md

please assign me :)

onlydustapp[bot] commented 1 month ago

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.

dev-chinx commented 1 month ago

hello @dmirgaleev i am a technical writer please can i work on this issue :) and would love to be a contributor

here are some of the docs i have writting: https://github.com/cairo-book/cairo-book/blob/main/src/ch16-05-01-price-feeds.md

onlydustapp[bot] commented 1 month ago

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.

pheobeayo commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a web3 frontend developer and Technical writer skilled in Typescript, Javascript, Solidity, Cairo and Rust. I also do lots off documentations on Readme files. This will help me in carrying out this task seamlessly. I have contributed to open source projects like Stark Quest

How I plan on tackling this issue

Osatuyi commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Can I be assigned this

How I plan on tackling this issue

I can do this

CollinsC1O commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

@dmirgaleev can I work on this please

Benjtalkshow commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I’m Benjamin, and I’m excited to work on adding a new documentation page for our project that will list reference test files. Since joining OnlyDust, I’ve made 18 contributions, and I’m confident in my documentation skills, so I believe I can make this page very useful for our community.

How I plan on tackling this issue

The goal is to set up a page that lists various test files. Here’s what I plan to include:

I’ll save this new markdown file in the docs/pages/examples.md path to keep everything organized.

To help me gather all the info and examples, I’ll check out these resources:

  1. DipDup Stone Packaging Test Files: This repository has a bunch of useful test files we can feature.

  2. Stone Prover Repository: This one offers great tips on creating and verifying proofs for Cairo programs.

  3. Once I put together all the reference test files and fill out the documentation, I’ll review everything to make sure it’s clear and easy to understand. Then, I’ll share it with you for feedback, so we can ensure it really meets the needs of what its meant for.

0xdevcollins commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

My name is Collins Ikechukwu. I'm a full stack blockchain developer developer.amd a technical writer

How I plan on tackling this issue

  1. Create a Documentation Page
    Start by creating a new markdown file at the specified path:
    docs/pages/examples.md

  2. List Reference Test Files
    On the page, list reference test files that include:

    • Cairo sources
    • Execution artifacts (trace, memory, input, output)
    • Prover parameters & config
    • Proof

  3. Brief Program Descriptions
    For each program, include a brief description that explains:

    • What the program does
    • Any arguments it accepts (if applicable)

  4. Use Existing References
    Refer to existing test files and examples from:

Benjtalkshow commented 1 month ago

@dmirgaleev Thanks will begin working asap

dmirgaleev commented 1 month ago

Hello @Benjtalkshow! Welcome aboard! Please don't hesitate to join our Telegram group https://t.me/baking_bad_odhack to ask questions and share your progress! Happy hacking!

Benjtalkshow commented 1 month ago

Hello @Benjtalkshow! Welcome aboard! Please don't hesitate to join our Telegram group https://t.me/baking_bad_odhack to ask questions and share your progress! Happy hacking!

Alright. Thanks

dmirgaleev commented 1 month ago

Friendly heads up that you have until Sunday (October 6) to push your final PR. @Benjtalkshow

Benjtalkshow commented 1 month ago

Friendly heads up that you have until Sunday (October 6) to push your final PR. @Benjtalkshow

Alright ser

Osatuyi commented 1 month ago

Can I be assigned this issue @dmirgaleev

ShantelPeters commented 1 month ago

Hi @dmirgaleev please can I be assigned to this issue.. I am available to work

0xdevcollins commented 1 month ago

Hello @dmirgaleev, may I give this a try?

martinvibes commented 2 weeks ago

hello @dmirgaleev can i work on this issue ? if this issue is still open

baitcode commented 2 weeks ago

@dmirgaleev I'd love to contribute here. I understand the structure of test data and happy to document it. I can also improve on example programs (to have arguments for example)

dmirgaleev commented 2 weeks ago

@baitcode awesome, let's go!:)

baitcode commented 2 weeks ago

Can't start today. Will start working on Friday!

dmirgaleev commented 2 weeks ago

No worries, no strict timelines for this