search

Vagabonds-Labs / cofiblocks

Welcome to Cofiblocks marketplace: A Starknet web3 platform to innovate Costa Rica coffee industry. Cofiblocks connects small coffee farmers directly with coffee lovers, cutting out unnecessary intermediaries.
https://www.cofiblocks.com/
10 stars 20 forks source link

Update and Enhance CofiBlocks README Documentation #63

Open evgongora opened 1 day ago

evgongora commented 1 day ago

Description:

The current README for CofiBlocks contains detailed information but needs refinement to improve readability, usability, and consistency. The objective is to centralize and structure the documentation, ensuring it effectively communicates the project’s purpose, technical setup, and contribution guidelines.

  1. Streamline Project Introduction
  1. Improve Setup Instructions
  1. Centralize Development Resources
  1. Remove Contribution Guide
  1. Highlight Roadmap and Team
mimisavage commented 1 day ago

@evgongora

I'm eager to take on this challenge and deliver quality work. May I proceed with it?

ShantelPeters commented 1 day ago

Hi @evgongora please can i be assigned to this issue

To resolve this issue, I will streamline the CofiBlocks README by clearly explaining its mission, operations, and key concepts like Collaborative Business, NFTs, and COFI tokens. Next I will improve setup instructions and centralize development resources, including tools like CofiBlocks Dev Assistant and technologies like Starknet, Prisma, and Bun. Then the contribution guide will be moved to a separate file. Additionally, I will highlight the project’s roadmap and team with concise bios and upcoming milestones.

0xdevcollins commented 1 day ago

Can I handle this task?

Kingsuite commented 1 day ago

Can I take care of this issue?

abdegenius commented 1 day ago

Is this issue still available? Would love to tackle this! I can comfortably handle this issues

pheobeayo commented 1 day ago

Could I grab this task? I am a Web3 front-end developer skilled in technical documentation and software development. I greatly understand technologies like JavaScript, Typescript, Cairo, Rust and Solidity. I have contributed successfully to open-source projects like Stark Quest and Speedrun scaffold-stark. My Approach includes Pull Request (PR) includes:

Iwueseiter commented 1 day ago

Can I attempt this issue? I'm a frontend/smart contract developer and a technical writer. Here are links to comprehensive docs I've written and have been merged Flex-NFT-Marketplace/Flex-Marketplace-Contract#107, https://github.com/cairo-book/cairo-book/pull/1019, https://github.com/horuslabsio/tokenbound-contract-docs/pull/12, https://github.com/sivicstudio/starkludo/pull/102, https://hackmd.io/@-__sK8xkRjuXHkFZQLyYXg/HkLcMImM1l.

martinvibes commented 1 day ago

Can I take care of this issue? i'm a frontend dev and a blockchain dev please kindly assign :)

mexes20 commented 1 day ago

ew developers, community members, and contributors quickly find answers to their questions

josephpdf commented 1 day ago

Hi! @evgongora I'm Joseph Poveda, I'm a member of the Dojo Coding community. A bit about my background is that I'm just starting out with Only Dust and I want to contribute as much as I can to the project. My knowledge of different programming languages ​​will allow me to better solve problems. To solve this issue I will:

  1. Optimize the Project Introduction:
    • Clearly describe what CofiBlocks is, its mission, and how it operates.
    • Ensure concise descriptions of key concepts like Collaborative Business, NFTs, and COFI tokens.
  2. Improve Setup Instructions:
    • Provide clear and error-free steps for project setup and development environment configuration.
  3. Centralize Development Resources:
    • Include detailed instructions for using tools like CofiBlocks Dev Assistant.
    • Add information on key technologies like Starknet, Prisma, and Bun.
  4. Remove the Contribution Guide:
    • Create a separate file for contribution guidelines.
  5. Highlight the Roadmap and Team:
    • Clearly present the project’s roadmap with upcoming milestones.
    • Introduce team members with concise bios. I hope this helps you structure your README effectively.
Iwueseiter commented 1 day ago

Is it okay if I take this? I'm a frontend/smart contract developer and a technical writer. Here are links to comprehensive docs I've written and have been merged Flex-NFT-Marketplace/Flex-Marketplace-Contract#107, https://github.com/cairo-book/cairo-book/pull/1019, https://github.com/horuslabsio/tokenbound-contract-docs/pull/12, https://github.com/sivicstudio/starkludo/pull/102, https://hackmd.io/@-__sK8xkRjuXHkFZQLyYXg/HkLcMImM1l.

gchimelu commented 1 day ago

Having gone through the CofiBlocks website and understood your mission of improving the coffee industry in Costa Rica, I would love to help you enhance your documentation, to make it more detailed and readable. I have worked with a lot of Web3 brands as a technical and content writer, so you will be getting the best of both worlds with me.

Benjtalkshow commented 1 day ago

Could I take on this issue?

ShantelPeters commented 1 day ago

Can I try solving this issue?

Michaelkingsdev commented 23 hours ago

May I take this issue on?

od-hunter commented 23 hours ago

Hello can I be assigned this please? I am a blockchain developer and I'm also good at documentations. I'll refine the README to improve readability, usability, and consistency to better communicate the project’s purpose, technical setup, and contribution guidelines.

Below are some of the documentations I've done that were merged: https://github.com/dojoengine/book/pull/308, https://github.com/keep-starknet-strange/joyboy/pull/143, https://github.com/Scaffold-Stark/ss2-docs/pull/31, https://github.com/horuslabsio/Starknet-Scaffold/pull/94, https://github.com/Hyle-org/examples/pull/15.

Please I’m ready to work, assign me please.

akintewe commented 21 hours ago

Hi, I'm akintewe and i would love to work on this issue I My ETA is > 24hrs to complete.

I am very good with documentation too.

I am a new contributor, happy to help :)

ryzen-xp commented 20 hours ago

Can I work on this, please?

vestor-dev commented 19 hours ago

hey sir I'd like to handle this task. i'm a frontend developer with experience i would really love to contribute to your project kindly assign :)

aguilar1x commented 18 hours ago

Good morning, My name is Matias Aguilar, I am a software development engineer with 1 year of experience in backend and some Frontend. I have worked on several issues on documentation so I already have an idea of how to implement everything and make it understandable and clean at the same time. I am a member of Dojo Coding, and I would really love to participate in the project with this issue.

Implementation and solution to the problem

I'm going to cover certain important points for the implementation of the docu, without leaving aside how I would start working on it

1. Fork Repository and create code in the same

2. Create Introduction

In this part there will be an introduction / explanation of guide lines to follow for the redame.md

README.md

The corresponding README.md will be created in a repository with:

  1. Project information
  2. Project structure
  3. Video presentation or page
  4. Team Members
  5. Technologies used
  6. And installation of the repository on its main fork

Doubts and recommendations

I'm waiting for questions and recommendations on how you would like to carry out the implementation of the README.md, so if you need any change or implementation of something or another. And maybe add the social media in the introduction of cofiblocks

ETA

1 day

Kritto commented 14 hours ago

Could I be assigned to this?

Kaminar-i commented 14 hours ago

Mind if I take this issue? i'm new and would love to work on this