[Book] Stone parameters

[dmirgaleev]

Add a documentation page that describes how to create a parameter file for the Stone prover depending on the program and what is the format of that file.

Path to your markdown file: docs/pages/usage/parameters.md

• The documentation page should be checked to make sure everything is correct.
• The page should be added to the sidebar https://github.com/dipdup-io/stone-packaging/blob/master/vocs.config.ts#L29

References:

• https://github.com/starkware-libs/stone-prover?tab=readme-ov-file#configuration-for-other-input-sizes
• https://blog.lambdaclass.com/overview-of-the-stone-prover/
• https://www.starknet.io/blog/diving-into-the-code-of-stone-prover-video/

[od-hunter]

Hi @dmirgaleev ,Please let me work on this when od hack starts.

[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.

[CollinsC1O]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a front-end and also a blockchain developer with experience in technical writing and documentation

How I plan on tackling this issue

• I will briefly explain Stone prover and the importance of parameter files in configuring it for different programs
• I will list the required fields like input parameters, program type and constraint
• I will provide an example configuration for clarity and better understanding
• I will specify the expected file format (e.g., JSON, YAML).
• I will outline key sections such as arguments, program type, and optional parameters.
• I will include steps for validating the parameter file before using it with the prover.

[ShantelPeters]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

i am a blockchain developer , this would be my first time contributing to this ecosystem .can i be assigned to this issue ,i am avaliable to work

How I plan on tackling this issue

To approch the problem i will create a documentation page:

1. Research: Review the provided references to understand how to create a parameter file for the Stone prover.
2. Write Documentation:
   -*Introduction: Briefly explain the purpose of the parameter file in the Stone prover.
   • Format: Describe the required format of the parameter file, including key sections and examples.
   • Creation Steps: Provide clear steps to create the parameter file based on the program:
     1. Identify program-specific requirements.
     2. Outline necessary parameters and their formats.
     3. Example content for a parameter file.
3. Markdown Formatting: Use headers, lists, and code blocks to enhance clarity.
4. Save the File: Name the file docs/pages/usage/parameters.md and integrate it into the documentation structure.

[LazarusAA]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi, I'm Alvaro Lazarus a passionate blockchain developer with a good amount of experience on this ecosystem, I love working on clean documentations which makes me confident I can complete this issue, I haven't worked with Stone Packaging before but would love for this to be my first contribution to the project.

How I plan on tackling this issue

To address the issue, I will introduce the Stone prover and highlight the importance of parameter files. I’ll outline key fields such as input parameters, program type, and constraints, and provide a sample configuration in the required format (JSON or YAML). Key sections will include arguments and optional parameters, along with steps for validating the parameter file before use. Finally, I will create structured documentation with headers and code blocks, saving it as docs/pages/usage/parameters.md for integration into the overall documentation.

Best regards,
Lazarus

[Kaminar-i]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

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

How I plan on tackling this issue

this will be my first time ccontributing to this repo

[dmirgaleev]

Hello @LazarusAA! 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!

[LazarusAA]

Thanks for the warm welcome @dmirgaleev! I'll work on the issue ASAP.

[dmirgaleev]

Hey @LazarusAA! Do you have any progress so far?

[akintewe]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm a CS major with experience in technical writing and documentation. I've produced and enhanced complex system documentation for a number of open-source projects. I have experience with zero-knowledge proofs and cryptographic protocols, which is helpful in comprehending and elucidating the Stone prover. I'm skilled with Markdown and have arranged technical data in an understandable way in the past.

How I plan on tackling this issue

I would start by carefully reading the included references to obtain a solid understanding of the Stone prover and its settings before creating the documentation page for Stone parameters. The Markdown file should be organised with sections explaining the function of parameter files, their format, and a detailed how-to for making them for various program kinds. I would describe each component, provide examples of parameter files for typical use scenarios, and go over how various parameters impact prover performance. In addition, I would discuss best practices and possible problems for choosing parameters. I would illustrate ideas throughout the document with simple language, brief bits of code, and maybe illustrations.

[dmirgaleev]

Friendly heads up that you have till Sunday (October 6) to push final PR. @akintewe

[akintewe]

alright got it

[martinvibes]

hello @dmirgaleev can i take on this issue :)

[Jemiiah]

hello @dmirgaleev kindly assign ETA: 48 hours max

[0xdevcollins]

Hello @dmirgaleev, may I give this a try?

[Jemiiah]

I’m still very much interested on this if it’s still open for contribution @dmirgaleev 🙃

[evgongora]

Hello @dmirgaleev! As a previous contributor to this project I would love to help with this task., I will start by creating the Markdown file: I'll add a new file parameters.md inside the docs/pages/usage/ directory and continue from there by researching how to create a parameter file and the format of the file. I'm ready to work :)