nexlabsweb3 / scanguard

https://scanguard.vercel.app
2 stars 2 forks source link

ScanGuard: Comprehensive User Guide and Technical Documentation #4

Open zintarh opened 18 hours ago

zintarh commented 18 hours ago

This issues is part of ODHACK 9.0, apply via the platform

Develop comprehensive documentation for ScanGuard, including a user guide with setup instructions and a technical section detailing the architecture and API references. This should provide clear guidance for both users and developers, covering features, best practices, and troubleshooting tips.

Please ensure to provide an ETA.

Looking forward to seeing your great work!

NueloSE commented 17 hours ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I have experience in technical writing and have contributed to several technical documentation within the Starknet space. with the above experience over time i can generate technical documentation to aid users and developers use the ScanGuard.

How I plan on tackling this issue

I would create a folder for documenting the ScanGaurd architecture. And produce an easy to use guide for scanguard.

ETA <= 72hrs

CollinsC1O commented 12 hours ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello I'm a front-end and a blockchain developer. I will love to solve this issue. I can handle this

martinvibes commented 1 hour ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

hello @ i'm a frontend developer and an experienced technical writer i would love to work on this issue Pleasee kindly assign :)

How I plan on tackling this issue

Task Summary:

Develop comprehensive documentation for ScanGuard, including: User Guide: Setup instructions, feature explanations, and best practices. Technical Section: Architecture details, API references, and troubleshooting tips. The documentation should cater to both users and developers.

ETA: 2 days

Joy-Adah commented 5 minutes ago

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 web3 developer, contributor and technical writer.

How I plan on tackling this issue

I plan to approach this issue by writing a comprehensive and well detailed documentation for ScanGuard. I will have this ready by 27th October.