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

Improve documentation #41

Merged
merged 1 commit into from
Jan 23, 2025
Merged

Improve documentation #41

merged 1 commit into from
Jan 23, 2025

Conversation

larkinscott
Copy link
Contributor

@larkinscott larkinscott commented Jan 15, 2025 •
edited
Loading

  • Added basic feature descriptions to the root README
  • Removed boilerplate from coverage and fmt READMEs
  • Added coverage and fmt specific documentation to their specific READMEs

@larkinscott larkinscott marked this pull request as ready for review January 15, 2025 19:31
@larkinscott larkinscott requested a review from brynary January 16, 2025 14:27
brynary
brynary approved these changes Jan 21, 2025
View reviewed changes
Copy link
Member

@brynary brynary left a comment

Choose a reason for hiding this comment

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

Rubber stamp approving this one since it's clearly better than what's currently in main and I'm a bit short on review cycles. Can always iterate in smaller follow ons

@noahd1 noahd1 merged commit 8fcf407 into main Jan 23, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brynary brynary brynary approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@larkinscott @brynary @noahd1