doc: Improve README of marketplace contracts

[0xandee]

Improve README.md by write documentation of marketplace contracts. The more details the better.

Tasks:

• [x] marketplace

[martinvibes]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

hello @0xandee kindly assign me to work on market place

i'm an experienced web3 developer and a technical writer

This are some of the docs i have written: doc 1 file, doc 2 file

i'll love to participate in this issue if i'm giving the opportunity : )

How I plan on tackling this issue

Provide Detailed Explanations: Describe the purpose, functionalities, usage, technical details, and examples for each contract. Maintain Clarity and Conciseness: Use clear and concise language that is easy to understand. Ensure Consistent Formatting: Use a consistent structure and formatting across all three folders. Collaboration:

Share Resources and Best Practices: Collaborate as a team to share knowledge and ensure quality. Benefits:

Improved Project Understanding: Comprehensive documentation helps developers understand the project better. Simplified Onboarding: New developers can easily learn about the contracts. Easier Integration: Other projects can more easily integrate with the codebase.

[Mystic-Nayy]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged Hi @0xandee I can work on this issue? I am a web3 developer and also a technical writer

How I plan on tackling this issue I can handle the MARKETPLACE or STAKING POOL If I am being assign I have a similar doc https://www.canva.com/design/DAGL_f-YQFI/OvylvJASq1yvUyYs_Gsk9g/view?utm_content=DAGL_f-YQFI&utm_campaign=designshare&utm_medium=link&utm_source=editor you can go through it

I have written a lot of merged documentation on OnlyDust here is my profile https://app.onlydust.com/u/Gift-Naomi

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

[Iwueseiter]

Hi @0xandee I’m open to work on the marketplace section of the README.MD I'm a smart contract developer and I've written documentations before. With that experience, I'd be able to update the README.MD to the expected standard.

I'd tackle this issue between 2 to 3 working days if assigned.

[raizo07]

Hello @0xandee I'll like to work on the Staking pool.

[onlydustapp[bot]]

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

[Calebux]

Hi @0xandee i'd like to take up Staking pool

[onlydustapp[bot]]

Hi @Calebux! 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 @Iwueseiter! 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 @Iwueseiter! 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 @raizo07! 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.

[Jemiiah]

Hello @0xandee I would love to work on this contributed to previous repos that required documentation https://github.com/dragan2234/worldcoin-scroll-bridge/pull/13 https://github.com/dragan2234/worldcoin-scroll-bridge/pull/11 https://github.com/NethermindEth/StarknetByExample/pull/200

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

[NueloSE]

hi @0xandee i would like to contribute to the marketplace documentation. As i have expirence contributing to technincal documents, previous article

[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 @Iwueseiter! 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.

[ShantelPeters]

Hi @0xandee I can work on this I am frontend developer and as well a technical writer.. please assign me

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

[CollinsC1O]

Hi @0xandee I will like to work on this

[onlydustapp[bot]]

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

[Joy-Adah]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi, my name is Joy and I am a developer and technical writer experienced in writing documentations.

How I plan on tackling this issue

I would approach this by going through the contracts written for marketplace and properly understanding the contract before improving and writing the documentation.

[Zeegaths]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm a blockcahin developer and technical writer. I have experience writing blogs, documentations and blockcahin education twitter threads.

How I plan on tackling this issue

I would first go through the contracts and understand what each one of them does. Then I would look at other docs in the projects, the write my first drafts to match the tone. Then refine them to perfection.

[BDCoy]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello, I’m Brayan. With over 3 years of experience in development, I am passionate about contributing to open-source projects and currently expanding my skill set with Rust, Cairo, and Solidity as part of my involvement with Dojo Coding. My recent role as a Full Stack Developer allowed me to specialize in a range of technologies including React, NextJs, Node.js, JavaScript, TypeScript, Docker, among many others. I am eager to apply my extensive experience and newly acquired skills to new challenges and innovative projects.

How I plan on tackling this issue

I would start by thoroughly reviewing the contracts written for openedition to fully understand them before proceeding to improve and document them.

[martinvibes]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

hello @0xandee kindly assign me to work on market place

i'm an experienced web3 developer and a technical writer

This are some of the docs i have written: doc 1 file, doc 2 file

i'll love to participate in this issue if i'm giving the opportunity : )

How I plan on tackling this issue

Provide Detailed Explanations: Describe the purpose, functionalities, usage, technical details, and examples for each contract. Maintain Clarity and Conciseness: Use clear and concise language that is easy to understand. Ensure Consistent Formatting: Use a consistent structure and formatting across all three folders. Collaboration:

Share Resources and Best Practices: Collaborate as a team to share knowledge and ensure quality. Benefits:

Improved Project Understanding: Comprehensive documentation helps developers understand the project better. Simplified Onboarding: New developers can easily learn about the contracts. Easier Integration: Other projects can more easily integrate with the codebase.

[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 experience with TypeScript and Rust, I also having little understanding of Cairo, with my experience as a Technical writer, working with markdown files, writing documentations, and contributing to open source documentations as well, I believe I will be able improve the README.md in a detailed manner.

How I plan on tackling this issue

I will first go through whichsoever contract that is assigned to me, understand it before writing in details about it. I will also go through how the other contracts already existing in the repository are written, and follow the same style.

[NueloSE]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am nuelo a frontend developer with experience in writing technical articles and documentation.

How I plan on tackling this issue

kindly assign me to contribute to marketplace

for this task i would tackle it using the following sections: Introduction Features Prerequisites Installation Deployment Contract Functions Create Listing Buy Item Cancel Listing Withdraw Funds Usage Examples Testing Security Considerations

each of the above section would contain well document examples and links to page for futher read up

i would using google, chapgpt and other starknet documentation to be able to implement a professional documentation for this task Best Practices Contributing License

[DiegoB1911]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm a Full Stack Developer with two years of experience. I'm also an active member of Dojo Coding, where I'm expanding my skills in Cairo and Web3 technologies. This is my first time participating in an Open Development Hackathon, and I'm eager to learn, contribute, and be part of a new project.

How I plan on tackling this issue

I’d be glad to work on improving the README.md by documenting the Marketplace, OpenEdition, and StakingPool contracts.

To achieve this, I will add the following sections:

Introduction: Overview of each contract and its role in the project. Installation and Setup: Instructions for setting up the contracts. Key Features and Functionalities: Detailed description of what each contract does. Usage Examples: Code snippets and examples for common use cases. API Reference: Documentation of public methods, parameters, and return types. Best Practices and Security Considerations: Guidance on best practices and security.

[Mystic-Nayy]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi @0xandee I can work on this issue? I am a web3 developer and also a technical writer

How I plan on tackling this issue

I can handle the MARKETPLACE or STAKING POOL If I am being assign I have a similar doc https://www.canva.com/design/DAGL_f-YQFI/OvylvJASq1yvUyYs_Gsk9g/view?utm_content=DAGL_f-YQFI&utm_campaign=designshare&utm_medium=link&utm_source=editor you can go through it

I have written a lot of merged documentation on OnlyDust here is my profile https://app.onlydust.com/u/Gift-Naom

[ScottyDavies]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am front end developer with 6 years experience. i have worked with microsoft on several projects, this will be my first time contributing to the hackathon and i am ready to work

How I plan on tackling this issue

I would approach this issue with following steps Assign the tasks: Assign one of the three contracts (marketplace, openedition, or stakingpool) to each of the three assignees. Make sure each assignee understands their respective task and the overall goal of improving the README.md file. Write the documentation for the assigned contract: Each assignee should research and understand the assigned contract in detail. They should then proceed to write comprehensive documentation for that contract, covering the following aspects: Contract Overview: Provide a high-level description of the contract, its purpose, and its key functionalities. Deployment and Configuration: Explain how the contract is deployed, any required configuration, and any necessary steps to set it up. Contract Functions: Describe the different functions available in the contract, their inputs, outputs, and their purpose. Events: List and explain the events emitted by the contract and their significance. Access Control: Discuss the access control mechanisms in place, such as who can interact with the contract and perform certain actions. Security Considerations: Highlight any known security measures or potential vulnerabilities that users should be aware of. Usage Examples: Provide sample code or step-by-step instructions on how to interact with the contract. Additional Resources: Include links to any relevant documentation, whitepapers, or external resources that can provide more information about the contract. Integrate the documentation into the README.md file: Once the assignees have completed the documentation for their respective contracts, they should coordinate with each other to integrate the content into the README.md file. The documentation for each contract should be added as a separate section in the README.md file, with clear headings and structure to maintain readability and organization. Ensure that the documentation is written in a clear and concise manner, using proper formatting (e.g., headings, bullet points, code blocks) to enhance the overall presentation. Review and refine the documentation: After the initial integration, the team should review the entire README.md file to ensure consistency, accuracy, and completeness of the documentation. Identify and address any gaps, inconsistencies, or areas that require further clarification or expansion. Incorporate feedback from the team and make necessary revisions to the documentation. Finalize and commit the changes: Once the documentation is complete and the team is satisfied with the result, the assignees should commit the changes to the README.md file. Ensure that the commit message clearly describes the improvements made to the documentation.

[raizo07]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello, I'll like to be assigned to work on this. I would love to be given the opportunity.

I would love to take the Stakingpool

I've worked on a lot of documentation the recent being the Starknet Docs https://github.com/starknet-io/starknet-docs/pull/1294

Below are other documentations I've worked on for several projects;

https://github.com/keep-starknet-strange/unruggable.meme/pull/233

https://github.com/strkfarm/starkfarm-client/pull/8

https://github.com/NethermindEth/StarknetByExample/pull/216

[ShantelPeters]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

To address the application form question and showcase how your background can be leveraged for improving the README.md with detailed documentation, you can highlight relevant skills and experiences. Here’s a structured way to present your background and its relevance:

---

Application Form: How Your Background Can Be Leveraged

As a frontend developer with a strong foundation in coding practices, documentation, and user experience, my background can be effectively leveraged to improve the README.md documentation for the marketplace, openedition, and stakingpool contracts. Here’s how my skills and experience align with the task:

1. Attention to Detail and Documentation Skills

• Experience: In my frontend development role, I regularly document code, features, and components to ensure clarity and maintainability. This involves writing detailed comments, creating user guides, and maintaining up-to-date documentation for various projects.
• Application: I will apply these skills to write comprehensive and clear documentation for each contract. This includes detailing functionality, providing usage examples, and ensuring that all relevant information is included in the README.md.

2. Technical Writing and Communication

• Experience: My experience includes creating technical documentation for complex frontend applications, which requires translating technical details into easily understandable content for various audiences.
• Application: I will use my technical writing skills to explain the contracts’ features, functions, and usage in a way that is accessible to both technical and non-technical readers. This includes structuring the documentation logically and using clear, concise language.

3. Understanding of Code Functionality and Best Practices

• Experience: As a frontend developer, I have a deep understanding of code structure, function definitions, and how different components interact. This experience helps in analyzing and documenting contract code effectively.
• Application: I will leverage my understanding of code to accurately describe the functionality of each contract, including how functions are implemented, how they interact with other components, and any specific details relevant to their use.

4. Experience with Version Control and Collaboration

• Experience: I am familiar with using version control systems like Git to manage changes, collaborate with team members, and ensure that documentation is integrated seamlessly into the project.
• Application: I will use my experience to coordinate with other team members working on the documentation, manage updates to the README.md, and ensure that the documentation for marketplace, openedition, and stakingpool is consistent and well-organized.

5. Commitment to Quality and Usability

• Experience: My work involves ensuring that user interfaces and documentation meet high standards of quality and usability. This includes thorough testing and review processes.
• Application: I will apply this commitment to ensure that the documentation is not only detailed and accurate but also user-friendly and easy to navigate.

Approach to Documentation

• Marketplaces Contract: Provide an overview, detailed feature descriptions, function explanations, usage examples, and deployment instructions.
• Openedition Contract: Include an overview, feature details, function descriptions, usage examples, and deployment instructions.
• Stakingpool Contract: Offer an overview, detailed feature descriptions, function explanations, usage examples, and deployment instructions.

By leveraging my background in frontend development, technical writing, and code understanding, I will ensure that the README.md documentation for each contract is comprehensive, clear, and valuable to users and developers alike.

---

How I plan on tackling this issue

To approach the task of improving the README.md by writing detailed documentation for the marketplace, openedition, and stakingpool contracts, here's a step-by-step plan:

1. Organize the Documentation Process

• Divide the Task: Since the task involves three different folders, assign one person to each folder: marketplace, openedition, and stakingpool. Each assignee will focus on writing comprehensive documentation for their assigned contract folder.
• Set Clear Guidelines: Provide clear instructions and a template to each assignee on what the documentation should include. This ensures consistency and completeness.

2. Documenting Each Contract

1. Marketplace Contract Documentation

• Overview: Describe the purpose and high-level functionality of the marketplace contract.
• Features:
  • Listing Items: Explain how items are listed in the marketplace, including any relevant parameters (e.g., item description, price).
  • Buying and Selling: Detail the process for buying and selling items, including any conditions or requirements.
  • Fees and Transactions: Document how transaction fees are handled and any related calculations.
• Functions:
  • Function Definitions: List and describe each function in the contract, including input parameters, return values, and any side effects.
  • Modifiers and Access Control: Explain any access control mechanisms or modifiers used in the contract.
• Usage Examples: Provide examples of how to interact with the contract, including code snippets for common operations.
• Deployment Instructions: Include any specific instructions for deploying the marketplace contract.

2. Openedition Contract Documentation

• Overview: Describe the purpose and functionality of the openedition contract.
• Features:
  • Edition Management: Explain how editions are created and managed within the contract.
  • Ownership and Transfers: Detail how ownership of editions is handled and the process for transferring ownership.
• Functions:
  • Function Definitions: List and describe each function, including how they are used and any associated events.
  • Modifiers and Access Control: Document any access control mechanisms and their purpose.
• Usage Examples: Provide code snippets and examples for interacting with the contract.
• Deployment Instructions: Include any necessary instructions for deploying the openedition contract.

3. Stakingpool Contract Documentation

• Overview: Describe the purpose and functionality of the stakingpool contract.
• Features:
  • Staking Mechanism: Explain how staking is implemented, including any rewards or penalties.
  • Rewards Distribution: Detail how rewards are calculated and distributed to users.
• Functions:
  • Function Definitions: Provide descriptions for each function, including details on their parameters and return values.
  • Modifiers and Access Control: Document any access control mechanisms and their use in the contract.
• Usage Examples: Include examples and code snippets for common interactions with the contract.
• Deployment Instructions: Provide instructions for deploying the stakingpool contract.

3. Writing and Structuring the Documentation

• Format: Use a consistent format for all three sections, including headings, subheadings, bullet points, and code blocks for readability.
• Clarity: Ensure that the documentation is clear and easy to understand, even for readers who may not be familiar with the contracts.
• Detail: Include as much detail as necessary to fully explain the functionality and usage of each contract.

4. Review and Integration

• Review Documentation: Once each assignee has completed their section, review the documentation for accuracy, completeness, and consistency.
• Merge into README.md: Integrate the documentation into the README.md file, ensuring that it flows logically and that each contract section is clearly delineated.

5. Final Review and Update

• Update README.md: Ensure that the README.md file is updated with the new documentation and that it is well-organized.
• Proofread: Proofread the entire README.md to catch any errors or inconsistencies.
• Update Instructions: If necessary, update any project-specific instructions or additional information.

[pheobeayo]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a skilled technical writer and web3 frontend developer who loves to document issues for easier comprehension of users.

How I plan on tackling this issue

I will go through the files where the documentation will be needed.

Run and understand the app successfully

Make necessary and comprehensive documentation of users.

Update the Readme

[EmmanuelAR]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Heyyy can i work on this? I Emmanuel Software dev from Costa Rica and Dojo Coding

How I plan on tackling this issue

1. Assign Tasks

   • 3 Contributors: • Assignee 1: marketplace • Assignee 2: openedition • Assignee 3: stakingpool

2. Documentation Structure

   • Overview: What the contract does. • Key Functions: Purpose, parameters, returns, events. • Deployment: How to deploy the contract. • Usage: Interaction examples. • Security: Important considerations.

3. Action

   • Each assignee writes detailed documentation for their assigned contract folder.

[Ibinola]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hi! My name is Michael, and I'm a Frontend Developer with experience contributing to open-source projects using Next.js, Tailwind CSS, and TypeScript. Most recently I've contributed to PEAR AI - https://trypear.ai/ (an open source ai code editor). Here are my recent commits and merged work

• Successfully implemented client-side form validation for user workflows (Sign In, Sign Up, and Forgot Password)
• Also worked on adding issue and pull request templates, which were merged in the same open-source project.

How I plan on tackling this issue

• I will start by reading which-ever folder i'm assigned to grasp their and purpose.

• I'll structure the documentation in a clear, organized manner, ensuring that each section is easy to navigate and understand. This will include an overview, setup instructions, usage examples, and any relevant details specific to the particular contract.

• For the folder I am assigned, I’ll provide in-depth explanations of the contract’s functionality, configuration options, and potential use cases.

• I will verify all documentation by testing the contracts in my local environment, ensuring that all instructions and details are accurate and complete.

• Finally, I'll seek feedback from the maintainers to ensure the documentation meets the project's standards and is helpful to both new and experienced developers.

[emmz3230]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

hi I am a front-end web developer, technical writer, and 3d developer.

How I plan on tackling this issue

What was your motivation? Why did you build this project? What problem does it solve? What makes your project stand out? If your project has a lot of features, will consider adding a "Features" section and listing them in the readme.

[onlydustapp[bot]]

The maintainer 0xandee has assigned pheobeayo to this issue via OnlyDust Platform. Good luck!