📝 Improve Documentation and Code Comments

[jlsneto]

This issue aims to enhance the project’s documentation by creating a detailed wiki or documentation page and ensuring all code is properly commented. Good documentation is essential for both new contributors and users, making it easier to understand and work with the project.

Goals

•   Create a Wiki or Documentation Page: Develop a centralized place for all key project documentation, including setup instructions, architecture overview, contribution guidelines, and more.
•   Document Undocumented Code: Review the codebase and add missing comments and explanations to functions, classes, and complex logic where necessary.
•   Improve existing documentation: Ensure that current documentation is up-to-date, clear, and easy to follow.

Tasks

•   Set up a Wiki or dedicated Documentation Page (e.g., GitHub Pages, Read the Docs).
•   Include sections for:
•   Project Overview
•   Installation and Setup
•   Contribution Guidelines
•   Code Structure/Architecture
•   Frequently Asked Questions (FAQ)
•   Review the codebase for missing or outdated comments.
•   Add or improve comments in areas that need explanation.
•   Ensure all public functions and classes have proper documentation (e.g., docstrings).
•   Update any outdated documentation currently in the repository.

How to Contribute

•   If you’re interested in helping with this issue, please comment below and indicate which parts of the documentation you’d like to work on.
•   Contributions can range from creating an entire wiki to simply adding a few missing comments in the code.
•   If you notice any additional gaps or issues in the documentation, feel free to mention them here.

Notes

•   Ensure that the new documentation follows a consistent style and format.
•   Any significant changes should be discussed before implementation to ensure alignment with the project’s overall vision.
•   Keep the documentation beginner-friendly where possible, especially in the project setup and contribution sections.