ODHack: Document the upgradeable component

[Darlington02]

Description:
This documentation will serve as a reference for developers and users who want to understand the functionality of the upgradeable component.

Goals:

• Explain the purpose of the Upgradeable component.
• Document the available functions

References:

• Link to existing documentation: https://docs.tbaexplorer.com/starknet-tokenbound-sdk/introduction-to-tokenbound
• Link to the code: https://github.com/horuslabsio/TBA/blob/v3/src/components/upgradeable/upgradeable.cairo
• New to contract documentations? Check out this sample docs as a guide: https://contracts-v2-docs.lens.xyz/contracts/libraries/ProfileLib.sol/library.ProfileLib

[Jemiiah]

I would love to work on this issue @Darlington02

[onlydustapp]

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]

Hello @Darlington02 I will love to work on this

[onlydustapp]

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.

[NueloSE]

@Darlington02 can i be assigned to work on this . some of my previous merged documentation:

• cairo quiz
• starknet.js

[onlydustapp]

Hi @NueloSE!
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]

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

[Mystic-Nayy]

@Darlington02 Can I work on this ?
I am a web3 developer/ Technical writer
I have experience in a lot of open source contributions especially in making Documentation
Here are some of the merged docs I’ve written
Flex-NFT-Marketplace/Flex-Marketplace-Contract@fc28412
https://hackmd.io/@xZ4BOZ5TTTy1I0ZQHXFOkg/rkFBcGgAC

[onlydustapp]

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

[Joy-Adah]

Hi @Darlington02 I would love to work on this. Can I be assigned?

[onlydustapp]

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

[PoulavBhowmick03]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

I'm Poulav Bhowmick, a software engineer at Invisible Studios with a robust background in TypeScript, Rust, Solidity Cairo, fullstack development and blockchain technology. My experience includes building robust applications, optimizing functionalities and blockchain integration. I have actively participated in events and open source contributions, enhancing my capability to tackle real-world tech challenges. My projects can be viewed on my GitHub Profile and OnlyDust Profile. Plus I´m active member of Starknet, Ethereum exosystem.

How I plan on tackling this issue

I will take a look at the current code and documentation and work on writing it as asked
ETA - 3 days

[raizo07]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

Hello @Darlington I'll like to be assigned to work on this. I'm a SOftware Dev with over four years experience and have worked on the Docss of several Projects on Starknet.

Here is a link to my profile https://app.onlydust.com/u/raizo07

[Jemiiah]

I am applying to this issue via OnlyDust platform.

My background and how it can be leveraged

@Darlington02 I have a great track record in documentation issue this are some of the issue i have worked on previously :
https://app.onlydust.com/u/Jemiiah I have a very good track record on docs issues here are some of the repositories I have worked on:
Flex-NFT-Marketplace/Flex-Marketplace-Contract#106
dragan2234/worldcoin-scroll-bridge#13
dragan2234/worldcoin-scroll-bridge#11
NethermindEth/StarknetByExample#200

How I plan on tackling this issue

Review the Existing Documentation:
Thoroughly understand the purpose and functionality of the upgradeable component as outlined in the existing documentation provided.
Study the Code:
Analyze the code in the upgradeable component (upgradeable.cairo) to gain insight into the implementation details and available functions.
Draft the New Documentation:
Begin by explaining the core purpose and benefits of using the upgradeable component.
Detail the various functions available within the component and their respective use cases.
Format and Structure:
Organize the documentation in a clear and structured format for easy comprehension by developers and users.
Utilize examples, code snippets, and diagrams where necessary to enhance understanding.

[onlydustapp]

The maintainer Darlington02 has assigned PoulavBhowmick03 to this issue via OnlyDust Platform.
Good luck!