Skip to content

Improve docs #5

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

Merged
merged 1 commit into from
May 9, 2025
Merged

Improve docs #5

merged 1 commit into from
May 9, 2025

Conversation

Qard
Copy link
Member

@Qard Qard commented May 9, 2025

I've split the internal notes docs into a separate file, cleaned up the readme a bit, and made sure to include the dependency requirements to get set up.

@Qard Qard requested review from mcollina and ShogunPanda May 9, 2025 13:55
@Qard Qard added the documentation Improvements or additions to documentation label May 9, 2025
Copy link

@ShogunPanda ShogunPanda left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@Qard Qard merged commit 4dec11f into main May 9, 2025
4 checks passed
@Qard Qard deleted the improve-docs branch May 9, 2025 14:30
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

Successfully merging this pull request may close these issues.

3 participants