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

improve source code documentation #12

Open
2 of 7 tasks
hulxv opened this issue Sep 18, 2024 · 0 comments
Open
2 of 7 tasks

improve source code documentation #12

hulxv opened this issue Sep 18, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@hulxv
Copy link
Collaborator

hulxv commented Sep 18, 2024

Introduction

The source code documentation is very poor and needs a lot of work to help new contributors get into the project and understand it. We will use rustdoc and document the source code directly. Also, We will need to add some comments to explain the complex process and the framework`s architecture.

Tasks

@hulxv hulxv added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Sep 18, 2024
@hulxv hulxv self-assigned this Sep 18, 2024
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 help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant