Prepare better docs and overview of current state of the project:

[dragan2234]

Write a good description of what the repo does, in the one README file.

So far we have multiple of these: https://github.com/dragan2234/worldcoin-scroll-bridge/blob/main/README.md https://github.com/dragan2234/worldcoin-scroll-bridge/blob/main/TASK_README.md https://github.com/dragan2234/worldcoin-scroll-bridge/blob/main/docs/src/README.md

https://github.com/dragan2234/worldcoin-scroll-bridge/blob/main/propagateRoot-relayer-services/readme.md

A lot of docs here: https://github.com/dragan2234/worldcoin-scroll-bridge/tree/main/service-to-sync-the-World-ID-merkle-tree-main

We need to make this more readable and better organized for further improvements and understanding of the project

[od-hunter]

Hi @dragan2234 ,Can I be assigned this once od hack starts please? This would be my first time contributing to this ecosystem.

I am a blockchain developer and I'm also good at documentations. Below are some of the documentations I've done that were merged:

https://github.com/dojoengine/book/pull/308#event-13866062226

https://github.com/keep-starknet-strange/joyboy/pull/143#event-13034455918,

https://github.com/horuslabsio/Starknet-Scaffold/pull/94#event-13007360671.

Some of my documentations outside GitHub:

https://t.co/ZgK0ccPZpw,

https://t.co/GnBqVQPECz.

I’m ready to update the README file and make it more readable and better organized for further improvements and understanding of the project. Please assign me.

[Gift-Naomi]

@dragan2234 can I be assigned to work on this? I am a web 3 developer/Technical writer, I have written a lot of documentation for different repos I will be very glad to work on this Here are some examples of the documentations i have written https://hackmd.io/@xZ4BOZ5TTTy1I0ZQHXFOkg/r1d5qqYLC, https://hackmd.io/@xZ4BOZ5TTTy1I0ZQHXFOkg/BJi6vmIIA

[onlydustapp[bot]]

Hi @Gift-Naomi! Maintainers during the ODHack # 7.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[bot]]

Hi @Gift-Naomi! Maintainers during the ODHack # 7.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[bot]]

Hi @od-hunter! Maintainers during the ODHack # 7.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.

[EjembiEmmanuel]

@dragan2234 I'd love to work on this

[onlydustapp[bot]]

Hi @EjembiEmmanuel! Maintainers during the ODHack # 7.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[bot]]

Hi @od-hunter! Maintainers during the ODHack # 7.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]

Hi @dragan2234 l’d love to work on this

[onlydustapp[bot]]

Hi @od-hunter! Maintainers during the ODHack # 7.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[bot]]

Hi @ShantelPeters! Maintainers during the ODHack # 7.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 @dragan2234 i would love to be assigned this issue if i'm giving the opportuinity to as it'll be my first issue :)

here are some of the docs i've written https://hackmd.io/@Martinez21/H1B3d7EPR, https://hackmd.io/@Martinez21/r1Q2uvgoA

i would to get this done and contribute to the ecosystem

[onlydustapp[bot]]

Hi @martinvibes! Maintainers during the ODHack # 7.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[bot]]

Hi @martinvibes! Maintainers during the ODHack # 7.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.

[GideonBature]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a Software Engineer and Technical writer, I have written some documentations as well as technical article. I believe with my experience of markdown and knowledge of technical writing, I should be able to work on this issue and get it done.

How I plan on tackling this issue

I have gone through the readme markdown files. Hence, I will go through each of them, organise them according to the flow, that is from the one of higher priority to the one of lesser priority, from there I will be able to come up with a full description of the whole repository in a single README.md file.

[Dprof-in-tech]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

As an experienced Full Stack Blockchain Developer, I'm excited to contribute my expertise to Edition 7 of the OnlyDust hackathons. With a strong background in Next.js, TypeScript, JavaScript, React, Node.js, Solidity, and Cairo, I've honed my technical skills across the blockchain development landscape. My journey with OnlyDust began at Edition 2, and I've since made 28 contributions across 11 projects. This extensive experience on the platform has allowed me to develop a keen understanding of delivering high-quality solutions under tight deadlines. I bring a unique blend of technical prowess and user-centric design to every project, whether I'm crafting immersive 3D experiences or developing innovative smart contracts. My track record demonstrates my ability to adapt quickly and contribute effectively to diverse challenges. I'm confident in my capacity to tackle new problems and drive innovation in the blockchain space. As we embark on Edition 7, I'm eager to leverage my hackathon experience and technical skills to push the boundaries of what's possible in blockchain development. With a passion for creating cutting-edge solutions, I'm excited to collaborate with the OnlyDust community and contribute to the advancement of the blockchain ecosystem.

How I plan on tackling this issue

To solve this issue, i would: Consolidate Information Review all existing README files and documentation. Extract key information from each source, including project overview, setup instructions, and component descriptions. Create a Main README Structure Develop a clear structure for the main README.md file, including sections such as: Project Overview Features Architecture Installation and Setup Usage Instructions Component Breakdown Contributing Guidelines License Information Write Comprehensive Content Craft a concise but informative project overview. Detail the key features of the worldcoin-scroll-bridge. Explain the high-level architecture of the system. Provide clear installation and setup instructions. Include usage examples and common operations. Break down and explain each major component of the project. Organize Sub-Documentation Create a 'docs' folder in the root of the repository. Move detailed documentation for specific components into separate markdown files within the 'docs' folder. Update the main README to link to these more detailed docs where appropriate. Standardize Format and Style Ensure consistent formatting throughout the README. Use clear headings, bullet points, and code blocks for readability. Include relevant diagrams or screenshots to illustrate complex concepts. Add Quick Start Guide Create a concise quick start section for developers who want to get up and running quickly. Review and Refine Conduct a thorough review of the new README. Ensure all critical information from the original sources is included. Refine language for clarity and conciseness. Update Repository Structure Remove or archive outdated README files. Ensure all links in the new README are functional. Seek Feedback Share the new README with team members for review. Incorporate feedback and make necessary adjustments.

[ikemHood]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hey, I am ikem Peter. a fullstack software developer with 3+ years of working experience, I would love to help out with this issue...

[Zeegaths]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm a blockchain developer and a technical writer. I have experience writing docs, blogs and twitter threads eduacting about different blockchain concepts.

How I plan on tackling this issue

I'ld first go through the repo and the docs throroughly so I', farmiliar with it. Then I'ld write the first draft, refine it untill it clear and matches the style of other worldcoin docs

[Abhi270303]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi, I am a Solidity developer, I prefer Foundry framework for testing smart contracts, I have decent experience in Writing Deploy Scripts for contracts and also Write Unit tests for testing contracts. I have also done Stateless fuzz testing. I always try to maintain the code quality so that it is easier for developers to understand the code. I believe my background can be leveraged to contribute to Worldcoin-scroll-bridge.

How I plan on tackling this issue

I propose streamlining the documentation by consolidating key information into a single, comprehensive README.md in the root directory. This will serve as the central hub, providing an engaging project overview, clear structure breakdown, and quick-start guide. We'll reorganize detailed docs into a well-structured /docs folder, implementing a consistent Markdown format across all files. To enhance navigability, we'll create a documentation index and standardize component-specific READMEs. This approach will significantly improve readability, make the project more approachable for newcomers, and facilitate easier maintenance as the project evolves. The result will be a more professional, user-friendly repository that effectively showcases the Worldcoin Scroll Bridge project.

[od-hunter]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi, please I'd love to be given the opportunity to contribute to this rep, I am a blockchain developer html, css, react, JavaScript, typescript, solidity and Cairo.

How I plan on tackling this issue

Hi @dragan2234 ,Can I be assigned this once od hack starts please? This would be my first time contributing to this ecosystem.

I am a blockchain developer and I'm also good at documentations. Below are some of the documentations I've done that were merged:

dojoengine/book#308 (comment)

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

horuslabsio/Starknet-Scaffold#94 (comment).

Some of my documentations outside GitHub:

https://t.co/ZgK0ccPZpw,

https://t.co/GnBqVQPECz.

I’m ready to update the README file and make it more readable and better organized for further improvements and understanding of the project. Please assign me.

[DIWAKARKASHYAP]

i want to work on this issue