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

Create a FAQ Section for CofiBlocks Documentation #65

Closed
evgongora opened this issue Nov 21, 2024 · 21 comments · Fixed by #66
Closed

Create a FAQ Section for CofiBlocks Documentation #65

evgongora opened this issue Nov 21, 2024 · 21 comments · Fixed by #66
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers ODHack10

Comments

@evgongora
Copy link
Collaborator

Description:

To improve the user experience and address common questions, we need to create a Frequently Asked Questions (FAQ) section in the documentation. This section will help new developers, community members, and contributors quickly find answers to their questions without having to search through the entire documentation or raise issues.

Objectives:

  1. Address Common Questions
  • Include questions related to CofiBlocks’ purpose, setup, features, and contributions.
  • Provide detailed and concise answers for each question.
  1. Organize for Accessibility
  • Structure the FAQ in categories (e.g., General, Technical, Community, Contribution).
  • Link relevant sections of the documentation to the answers for further details.

Be creative!

@evgongora evgongora added documentation Improvements or additions to documentation good first issue Good for newcomers ODHack10 labels Nov 21, 2024
@Benjtalkshow
Copy link

@evgongora
I am a Full Stack Developer with a strong background in blockchain and extensive experience in Next.js/React, TypeScript, and Rust. I’ve made over 45 contributions to over 15 projects in the OnlyDust ecosystem, solving complex issues and delivering efficient, scalable solutions.

Can this task be assigned to me? I will make PR in 24hrs.

@mimisavage
Copy link

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

@0xdevcollins
Copy link

Hello @evgongora, I would love to take on this task.

I am a Full Stack Blockchain Developer with expertise in Next.js, TypeScript, React, Node.js, and Solidity/Rust. With 46 contributions across 10 OnlyDust projects, I bring technical excellence, adaptability, and a focus on user-centric blockchain solutions.

@ShantelPeters
Copy link

ShantelPeters commented Nov 21, 2024

Hi @evgongora can i please be assigned to this issue
i am frontend and blockchain developer, with experience in Typescript,React, Next.js , cairo etc . This would be my first time contributing

@wheval
Copy link

wheval commented Nov 21, 2024

Hello @evgongora,
I'm Wheval a frontend developer with multiple experiences working with Nextjs and TypeScript. Can i work on this?

I can create a FAQ section for easy documentation.
I would ensure to address common questions that I would probably have had as a developer concerning the purpose, setup and features with straightforward answers.
I would also structure it in proper categories and link documentations where necessary.

ETA is 2 days because I have to really come up with the right questions and their answers.

@abdegenius
Copy link

I can comfortably handle this issues

@Joewizy
Copy link

Joewizy commented Nov 21, 2024

Can I take this from here?
I love documentations

@NueloSE
Copy link

NueloSE commented Nov 21, 2024

Could I take a shot at this?

@zintarh
Copy link
Contributor

zintarh commented Nov 21, 2024

Can I jump on this task?

@martinvibes
Copy link

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

@mexes20
Copy link

mexes20 commented Nov 21, 2024

May I pick this up? I have three years experience in Software development and have contributed to some projects on OD here.

I'll create a proper and concise FAQ section in the docs, that will help new developers, community members, and contributors quickly find answers to their questions.

ETA: 10 hours.

@Iwueseiter
Copy link

May I handle 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, cairo-book/cairo-book#1019, horuslabsio/tokenbound-contract-docs#12, sivicstudio/starkludo#102, https://hackmd.io/@-__sK8xkRjuXHkFZQLyYXg/HkLcMImM1l.

@gchimelu
Copy link

Hello,
I would love to help with putting FAQs together for your documentation. With more than four years of experience working as a Web3 writer, I can quickly address common questions, provide detailed answers, and organize them in a way users can easily understand them.

@Joe-joe25
Copy link

I’d like to tackle this issue by identifying common questions, drafting concise answers, and integrating them into the documentation.

@akintewe
Copy link

Hello can i be assigned this issue, i am a new contributor with experience in Cario and typescript, would love to work on this , my ETA is >4 Hours and ill create a draft PR in 3 hours time. Thank you for this opportunity. :)

@Michaelkingsdev
Copy link

May I handle this issue? I am an experienced frontend developer with 3 years of experience.

@od-hunter
Copy link
Contributor

Hello can I be assigned this please? I am a blockchain developer and I'm also good at documentations.

The documentation I'll do will improve user experience and address common questions. I'll also create a Frequently Asked Questions (FAQ) section in the documentation, to help new developers, community members, and contributors to quickly find answers to their questions without having to search through the entire documentation or raise issues.

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

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

@EmmanuelAR
Copy link
Contributor

May I be assigned to this? I can create and excellent faq file, i will ask the team about the regular questions and add it, im from dojo coding and go stark me manteiner

@MullerTheScientist
Copy link

I am a full-stack developer with experience in QA testing and languages like Python, Cairo, Solidity, React, and JavaScript. Please i'd love to handle this task

@evgongora
Copy link
Collaborator Author

@EmmanuelAR Assigned! Let us know if you have any questions

@EmmanuelAR
Copy link
Contributor

Thks Sr @evgongora, will deliver asap!

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

Successfully merging a pull request may close this issue.