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

Final docs and audit cleanup #198

Merged
merged 3 commits into from
Jan 31, 2024

Conversation

Mr0grog
Copy link
Contributor

@Mr0grog Mr0grog commented Jan 27, 2024

This is the last bit of cleanup I wanted to do to close out #191. There are a few overlapping things here (let me know if I should pull any of these out):

  • Added more detail to CONTRIBUTING.md about required versions, manual testing and debugging, etc.
  • Fixed assorted typos, minor grammar things, marked up inline code snippets and symbol references as code, made issue references into links, made directory references consistent (e.g. lib/ vs. /lib), etc. in docs.
  • A few more dependency updates to clear all the remaining audit issues.

This is a quick cleanup of the readme and contributing docs to fix a few minor grammar issues and typos, add a lot of tildes around strings of code or references to symbols in the library ("console" is a little complex; I've tried to add tildes when referred to as a symbol or object, but not for things like "the browser's console in the devtools" and such), make sure issues/PRs are all linked in the release notes section, and make sure directories are referred to in a consistent way.
@pimterry pimterry merged commit 3c5c7f1 into pimterry:master Jan 31, 2024
10 checks passed
@pimterry
Copy link
Owner

Nice work, thanks! These all look like great improvements 👍

@Mr0grog Mr0grog deleted the 191-contributing-docs-cleanup branch January 31, 2024 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants