📚 Missing `docs/` Folder with `.rst` Files for Read the Docs

[ARYAN-NIKNEZHAD]

Description:

The package lacks a docs/ folder containing reStructuredText (.rst) files necessary for building comprehensive documentation on platforms like Read the Docs. This is essential for providing detailed usage, installation, API, and development guides, making the project accessible and easier to contribute to.

Problems Identified:

1. No Documentation for End Users:

   • Without proper documentation, users may struggle to understand how to install, configure, and use the package. This can result in:
     • Increased support requests.
     • Limited adoption by the developer community.

2. Lack of API Reference:

   • Missing API documentation makes it difficult for developers to explore and use the package's features effectively. Without proper documentation on each class, method, and attribute, users might resort to inspecting source code instead of reading well-formatted docs.

3. No Installation or Setup Guides:

   • A missing docs/ folder means there's no dedicated space for installation, configuration, and setup instructions. This can lead to confusion for users when setting up the package in different environments.

4. No Contribution Guidelines:

   • The absence of documentation related to contribution (such as development setup, code structure, or how to submit pull requests) makes it harder for new contributors to get involved.

5. Not Compatible with Read the Docs:

   • Without a proper folder structure and .rst files, the project cannot integrate with Read the Docs, which is a common platform for open-source project documentation. This prevents automatic documentation generation and hosting.