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 front-facing documentation #5

Merged
merged 3 commits into from
Sep 10, 2024
Merged

Improve front-facing documentation #5

merged 3 commits into from
Sep 10, 2024

Conversation

No767
Copy link
Member

@No767 No767 commented Sep 10, 2024

Summary

This PR focuses on improving the CONTRIBUTING.md and README.md documents. Although other documentation (including the setup docs) are not written yet (waiting on domain name change), they will be added later.

Types of changes

What types of changes does your code introduce to Kanae?
Put an x in the boxes that apply

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update (Updates to README.md, the documentation, etc)
  • Other (if none of the other choices apply)

Checklist

Put an x in the boxes that apply

  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes. (if appropriate)
  • All workflows (except pre-commit.ci) pass with my new changes
  • This PR does not address a duplicate issue or PR

@No767 No767 merged commit 31ddebf into main Sep 10, 2024
5 of 6 checks passed
@No767 No767 deleted the noelle/improve-docs branch September 10, 2024 07: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.

1 participant