Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add proper documentations for the project using mkdocs #48

Open
Zingzy opened this issue Jan 8, 2025 · 0 comments
Open

Add proper documentations for the project using mkdocs #48

Zingzy opened this issue Jan 8, 2025 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Zingzy
Copy link
Owner

Zingzy commented Jan 8, 2025

The current state of the project's documentation is quite disorganized. Initially, the project was small, so we decided to write the documentation directly in the README.md file. However, with the project's rapid growth and the addition of numerous new features, it makes sense to transition to a more robust and descriptive documentation system using a tool like mkdocs.

Tasks for Documentation Update:

The tasks list would be updated soon

@Zingzy Zingzy added the documentation Improvements or additions to documentation label Jan 8, 2025
@Zingzy Zingzy self-assigned this Jan 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant