Documentation: Documenting Codes in the Scripts Folder

[CristopherAguilar10]

The code in the Scripts folder needs documentation to improve its understanding and facilitate collaboration with other developers.

Tasks:

1. Add XML comments to methods, classes and public variables.

• Example:

/// <summary> 
/// Controls the movement of the player.
/// </summary> 
/// <param name=“speed”>Speed of the movement.</param> 
void MovePlayer(float speed) { // Implementation here }

2. Document the general functionality of each script:

• What the script does.
• Where and how it is used.

[martinvibes]

May I try my hand at this? I have done some merged docs for other repos
It would be my first time on this repo
Kindly assign :)

[pheobeayo]

May I handle this issue?

I am a web3 frontend developer and Technical writer. I have successfully contributed to projects on the OnlyDust platform, writing Cairo, and Rust codes, cleaning up the codebase and properly documentating the codes.

I will tackle this issue by going through the documentation properly, studying the script codes, understanding the codes, understanding the functions and writing out the functions in the proper documentation for better understanding of developers and users.

[raizo07]

I’d like to resolve this.

[josephpdf]

Hi! @CristopherAguilar10
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.
Now to tackle the problem of documenting scripts folder:

1. Review the Scripts — Go through each of the scripts in the folder to understand how they function, their purpose, and implementation.
2. XML Comments: Add XML comments to methods, classes and public variables. For example:

/// <summary>
/// Controls player movement.
/// </summary>
/// <param name="speed">The speed of movement.</param>
void MovePlayer(float speed) { }

3. Document Script Descriptions : You are writing what exactly each script do and in which it is used, so developer will understand easily.
4. Put Content in Structure: Properly document everything so it can be accessed and understood with ease.

[BraCR10]

Hello maintainers I am BRACR10 a contributor from Dojo Coding, I would like to take the documentation of those scripts, I have experience with object oriented programming and C#. Before requesting the issue I looked the scripts and the without problems could comment them properly with XML format.

[CristopherAguilar10]

Hi @josephpdf, I assign you, if you have any questions I will be glad to help you.

[0xdevcollins]

Could I be assigned to this?

My Background
I am a Full Stack Blockchain Developer with proficiency in Solidity/Rust, Next.js, TypeScript, React, and Node.js. I've demonstrated my ability to adjust to a variety of requirements, perform well under pressure, and reliably produce user-centric blockchain solutions with 46 significant contributions spread over 12 OnlyDust projects.

[emmz3230]

I am a front-end developer specializing in responsive web design,
device-compatible email templates, 3D web integration,
and technical writing on programming topics.

step on how to solve this issue
I will take my time to understand the script code and document it in the code or create a script.md file to better understand the code by any developer using my project documenting skill to stat what it does and how it is used, which I can say is one of my habits when seeing large codebases.

will be glad to work on this
Thanks

[NueloSE]

Am a technical writer with experience in documenting code base

previous work done that is exactly same as the bytebeast doc script

Can I contribute to this one?
ETA <= 2days