search

horuslabsio / tokenbound-contract-docs

Tokenbound contract documentation
1 stars 9 forks source link

ODHACK: Document the account component #3

Closed Darlington02 closed 1 month ago

Darlington02 commented 2 months ago

Description: This documentation will serve as a reference for developers and users who want to understand the Account Component.

Goals:

References:

ShantelPeters commented 2 months ago

Hi @Darlington02 please can I be assigned to this issue?

onlydustapp[bot] commented 2 months ago

Hi @ShantelPeters! Maintainers during the ODHack # 8.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 commented 2 months ago

@Darlington02 i would love to work on this issue

onlydustapp[bot] commented 2 months ago

Hi @Jemiiah! Maintainers during the ODHack # 8.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 commented 2 months ago

I will love to work on this @Darlington02

onlydustapp[bot] commented 2 months ago

Hi @CollinsC1O! Maintainers during the ODHack # 8.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] commented 2 months ago

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

Kaminar-i commented 2 months ago

@Darlington02, please can I get this issue assigned to me

onlydustapp[bot] commented 2 months ago

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

codeZe-us commented 2 months ago

@Darlington02 I can document this.

onlydustapp[bot] commented 2 months ago

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

pheobeayo commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a web3 frontend developer and technical writer skilled in Typescript, Javascript, Solidity, Cairo and Rust. I believe my background in Cairo and Rust having gone through the starknet bootcamp will help me in this documentation having done some documentation on some ReadMe files as a developer.

How I plan on tackling this issue

Here is how I will approach this documentation.

CollinsC1O commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

hello @Darlington02 I will love to work on this. please assign

How I plan on tackling this issue

I can implement the documentation for the account component.

Benjtalkshow commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I’m a full-stack developer with experience in blockchain and smart contract documentation. I've worked on several projects where explaining technical components in a simple way is key to helping developers and users. The Account component documentation will serve as a guide for understanding its purpose and how to use it effectively.

How I plan on tackling this issue

To start, I will review the Account component code in detail. This will allow me to understand how it works and how each function contributes to the overall component. Once I have a good grasp of the code, I will write a section explaining the purpose of the Account component. This explanation will outline why it exists, what problem it solves, and how it fits into the broader project context, making it easier for users to comprehend its value.

I will then break down each function in the component, explaining what it does, what inputs are required, and what outputs it produces. By doing so, I will provide practical examples to show how these functions can be used, which will make the documentation more practical and actionable for developers.

In addition to documenting the component itself, I will ensure the documentation contains useful links to other parts of the project or external references, so that users can further explore related topics. Finally, I will review the documentation to ensure it is easy to understand, free of errors, and properly integrated into the project's existing documentation.

In terms of the timeline, I will begin by thoroughly reviewing the code and drafting an overview of the component. Following that, I will document the functions in detail, with examples to demonstrate their usage. Once the documentation is drafted, I will conduct a final review to polish and finalize it.

rishabhguptareal commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I am a technical content writer, and I have already created the necessary documentation and code to address this issue. I am eager to get assigned to this project and contribute effectively. Additionally, I’ve outlined my approach to solving this problem, ensuring that I understand the requirements and provide a comprehensive solution. I look forward to collaborating with the team!

How I plan on tackling this issue

To approach this problem, I would start by ensuring I fully understand the requirements. This means reading the problem statement carefully to grasp the goals and objectives. I’d identify key components, like the Account component, the StarkNet Tokenbound SDK, and relevant contract documentation. I would also review any provided references and existing code to gain a clearer context.

Next, I would break down the problem into smaller tasks. This would involve explaining what the Account component does, documenting its available functions, and pointing to existing documentation and code for further reference.

After that, I would research the Account component to better understand its functionality and how it fits into the overall system. This includes reviewing existing documentation and code to gather more insights about its implementation and usage.

With all this information, I would create comprehensive documentation for the Account component. This would include a clear explanation of its purpose, detailed descriptions of its functions (including parameters and return values), and references to existing documentation and code.

Finally, I would review the documentation to ensure it’s accurate, clear, and meets the necessary requirements. This structured approach would help me provide a thorough and reliable solution.

martinvibes commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

hello i am a frontend developer and a technical writer please can i work on this issue :) i would love to be a contributor on this repo

How I plan on tackling this issue

hello @Darlington02 please i'm ready and i would love to take on this issue i'm a frontend developer and a technical writer

here are some of the docs i have writting: https://github.com/cairo-book/cairo-book/blob/main/src/ch16-05-01-price-feeds.md https://github.com/bandada-infra/bandada/blob/main/README.md https://github.com/lfglabs-dev/starknet.quest/blob/testnet/docs/CONTRIBUTING.md

please assign me :)

ScottyDavies commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I have a background in blockchain development and technical writing, with experience in smart contract implementation and documentation

How I plan on tackling this issue

I would approach this issue with the following steps:

Review the code and existing documentation to clearly define the Account component’s role within the Token Bound SDK.

Document Functions: Analyze the available functions in the account.cairo file, detailing their inputs, outputs, and use cases. Provide examples where applicable.

Structure the Documentation: Organize the content into clear sections—Introduction, Purpose, Functions, and References—to enhance readability.

Use Clear Language: Ensure the documentation is accessible to both developers and non-developers, using straightforward language and avoiding jargon where possible.

Include References: Link to the existing documentation and relevant resources for further reading, ensuring users can easily find additional information.

ikemHood commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hey @Darlington02, can i get this done?

mimisavage commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

My name is mimisavage. I'm a full stack blockchain developer developer and a technical writer.

How I plan on tackling this issue

  1. Introduction to the Account Component
    Start the documentation by explaining the purpose of the Account component. Describe how it fits within the broader system and its role within the Starknet Tokenbound SDK.

  2. Document Available Functions
    List and explain each function in the Account component:

    • Provide a brief description of what each function does.
    • Include details on the inputs (arguments) and outputs (return values) for each function.
    • If necessary, explain usage examples or scenarios.

  3. References
    Utilize the following resources for structure and information:

sasasamaes commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

JavaScript developer with 5+ years of experience involved in the full software development lifecycle. My experience includes providing IT solutions for enterprises using JavaScript, React, TypeScript, Node.js, and MongoDB. Additionally, I am expanding my knowledge in Web3 technologies, particularly in Cairo and Solidity.

I am also a community leader and sensei at Dev.f, where I mentor and lead a vibrant community of developers and am a Dojo Coding Member.

My areas of interest include Web3, frontend, backend, and full-stack development.

How I plan on tackling this issue

Review existing documentation: Understand the purpose and functionality of the component to be documented in depth with the help of the given documentation. Format and structure: Organize the documentation in a clear and structured format so that developers and users can easily understand it. Use examples, code snippets, and diagrams where necessary to improve understanding.

od-hunter commented 2 months ago

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello can I be assigned this please? 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.

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

onlydustapp[bot] commented 2 months ago

The maintainer Darlington02 has assigned od-hunter to this issue via OnlyDust Platform. Good luck!