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

Reorganized README.md #637

Merged
merged 2 commits into from
Oct 18, 2021
Merged

Reorganized README.md #637

merged 2 commits into from
Oct 18, 2021

Conversation

Ronqn
Copy link
Contributor

@Ronqn Ronqn commented Oct 16, 2021

Fixes #636

Created new files called NOTES.md, FILES.md, RELEASES.md and moved them alongside CONTRIBUTING.md and SECURITY.md in a new folder called "docs".

Updated the README.md to reflect these changes.

@stleary
Copy link
Owner

stleary commented Oct 18, 2021

What problem does this code solve?
Updating the readme and other documentation, which was getting a bit unwieldy.

Risks
Low

Changes to the API?
N/A

Will this require a new release?
No

Should the documentation be updated?
This is the documentation

Does it break the unit tests?
N/A

Was any code refactored in this commit?
N/A

Review status
ACCEPTED

@stleary
Copy link
Owner

stleary commented Oct 18, 2021

Skipping the 3-day comment window, since this is a doc change.

@stleary stleary merged commit 93f4b34 into stleary:master Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readme should be reorganized
2 participants