Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Book] Stone parameters #28

Open
Tracked by #18
dmirgaleev opened this issue Sep 25, 2024 · 6 comments
Open
Tracked by #18

[Book] Stone parameters #28

dmirgaleev opened this issue Sep 25, 2024 · 6 comments
Labels
difficulty: hard documentation Improvements or additions to documentation good first issue Good for newcomers ODHack8

Comments

@dmirgaleev
Copy link
Member

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

References:

@dmirgaleev dmirgaleev added documentation Improvements or additions to documentation good first issue Good for newcomers ODHack8 difficulty: hard labels Sep 25, 2024
@od-hunter
Copy link

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

Copy link

onlydustapp bot commented Sep 25, 2024

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.

@dmirgaleev dmirgaleev mentioned this issue Sep 25, 2024
14 tasks
@CollinsC1O
Copy link

CollinsC1O commented Sep 26, 2024

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
Copy link

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
Copy link

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
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: hard documentation Improvements or additions to documentation good first issue Good for newcomers ODHack8
Projects
None yet
Development

No branches or pull requests

6 participants