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.

Sign up for GitHub

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

Jump to bottom

docs: add project docs #124

Merged
merged 1 commit into from
Dec 11, 2024
Merged

docs: add project docs #124

merged 1 commit into from
Dec 11, 2024

Conversation

timerring
Copy link
Owner

Description

Add the project docs as well as remove some reduntant infomation.

Who Can Review?

@timerring

Checklist

  • Code has been reviewed
  • Code complies with the project's code standards and best practices
  • Code has passed all tests
  • Code does not affect the normal use of existing features
  • Code has been commented properly
  • Documentation has been updated (if applicable)
  • Demo/checkpoint has been attached (if applicable)

@timerring timerring added the documentation Improvements or additions to documentation label Dec 11, 2024
@timerring timerring self-assigned this Dec 11, 2024
timerring
timerring commented Dec 11, 2024
View reviewed changes
Copy link
Owner Author

@timerring timerring left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@timerring timerring merged commit b2d442a into main Dec 11, 2024
@timerring timerring deleted the dev branch December 11, 2024 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@timerring timerring

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@timerring