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] Integrate Vocs framework #21

Closed dmirgaleev closed 1 month ago

dmirgaleev commented 1 month ago

Integrate vocs framework https://vocs.dev/docs to assemble a static site out of markdown files.
Add instructions how to build and run dev server locally to the readme (+ installation steps).

References:

CollinsC1O commented 1 month ago

Hi @dmirgaleev I'm a frontend and a blockchain developer. I will love to work on this. I'm ready to work

onlydustapp[bot] commented 1 month ago

Hi @CollinsC1O! 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.

ShantelPeters commented 1 month ago

i will like to work on this issue @dmirgaleev kindly assign i am ready to work.

onlydustapp[bot] commented 1 month ago

Hi @ShantelPeters! 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 please can i work on this issue :) and would love to be a contributor

onlydustapp[bot] commented 1 month ago

Hi @dev-chinx! 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.

NueloSE commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

i am a frontend developer with experience in technical writing and documentation using tools like Docusaurus and Jekyll. with my experience using the framework i would be able to handle this task as vocs is also a similar framework

How I plan on tackling this issue

  1. Set up the project with VOCS
  2. Organize markdown file by placing them in a directory and configuring Vocs to pull content from this directory.
  3. Configure the VOCS to build the static site using the files in 2 above
  4. set up the dev server
  5. Add all the building and run instruction to the readme file.
ShantelPeters commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a blockchain developer with vast experiences with in css ,react, typescript,javascript ,solidity etc.

How I plan on tackling this issue

I intend to approach the problem with the following :

  1. Set Up Vocs: Follow the [Vocs documentation]to install the framework. Use the instructions to assemble the static site from the existing markdown files.

  2. Configure Build: Ensure the site is configured properly by adding necessary configurations

  3. Update README:

    • Include installation steps
    • Add instructions for building (m and running the dev server locally.

  4. Test: Verify the build and dev server locally to ensure everything runs smoothly.

I am using the DojoEngine book repo as a reference

josephchimebuka commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello, I am Joseph I am a Software developer and blockchain developer and I am also an active contributor here on only dust here is my profile https://app.onlydust.com/u/josephchimebuka. This is my first time to contribute to this repo ill appreciate the opportunity to contribute. this is a couple of frontend and blockchain projects i have built https://metacrypt.vercel.app/ https://mattedsgn.com/ I have also written articles too here is an article for written for Karst https://medium.com/@josephchimebuka/krast-a-decentralized-social-graph-built-on-starknet-with-erc-6551-c4c9800b5a9d

How I plan on tackling this issue

The descriptionis already detailed I will follow it to solve the issue in 2-3 days

MullerTheScientist commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a full-stack developer with experience in QA testing and languages like Python, Cairo, Solidity, React, and JavaScript.

How I plan on tackling this issue

i will Understand VOCs Framework Study the VOCs framework: Define VOCs and its importance Identify key components (e.g., collect, analyze, act) Identify Customer Feedback Channels Determine customer feedback channels: Surveys Social media Support tickets Reviews

Kaminar-i commented 1 month ago

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

please kindly assign me and i'll get straight to work

Luluameh commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I have experience in web development and frontend frameworks, particularly with static site generation and Markdown integration.

How I plan on tackling this issue

I would integrate the Vocs framework by setting it up to generate a static site from Markdown files, updating the README with build and run instructions, and testing the integration to ensure everything works smoothly.

akintewe commented 1 month ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I hold a degree in computer science and have worked as a mobile developer with React and JavaScript, two of the Vocs framework's primary technologies. I have experience working with static site generators such as Jekyll and Docusaurus on a number of documentation projects. My knowledge of contemporary web technologies and my experience with frontend development make me a good fit to integrate Vocs and enhance the project's documentation system.

How I plan on tackling this issue

Studying the Vocs documentation and the present project structure would be my first steps. Next, I would configure Vocs in the project such that it would function with the already-existing markdown files. I would make a vocs.config.js file to alter the look and feel of the website. I would then modify the build procedure to use Vocs to create the static website. For local testing, I would include a dev server script. Lastly, I would provide explicit instructions to the README for installing the software, creating the website, and starting the development server locally. I would make sure the current material is correctly transferred and rendered in the new system during the entire process.

dmirgaleev commented 1 month ago

Hello @akintewe! Welcome aboard! Please don't hesitate to join our Telegram group https://t.me/baking_bad_odhack to ask questions and share your progress! It is recommended to share your progress on a daily basis. Happy hacking!

akintewe commented 1 month ago

Thank you very much for this opportunity

dmirgaleev commented 1 month ago

Resolved in https://github.com/dipdup-io/stone-packaging/pull/44