Skip to content

Update readme #125

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 10 commits into from
Aug 8, 2023
Merged

Update readme #125

merged 10 commits into from
Aug 8, 2023

Conversation

sydneysugar
Copy link
Contributor

Internal Notes for Reviewers

Responding to this story: https://app.shortcut.com/validmind/story/1971/update-readme-md-files-in-for-open-source-repos

Removes sections that would not be used by external contributors and adds instructions for how to contribute.

External Release Notes

Updates to the README file in the documentation repo for open source contributions to the docs.

@sydneysugar sydneysugar added the enhancement New feature or request label Aug 2, 2023
@sydneysugar sydneysugar requested a review from nrichers August 2, 2023 23:27
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

Thank you for updating our documentation repo readme, @sydneysugar! 🏅 I made some suggested edits you can commit and will approve afterwards. Have a great weekend!

sydneysugar and others added 6 commits August 4, 2023 09:28
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Co-authored-by: Nik Richers <nik@validmind.ai>
Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you for addressing my comments, @sydneysugar.

@sydneysugar sydneysugar merged commit ac323b8 into main Aug 8, 2023
@sydneysugar sydneysugar deleted the update-readme branch August 8, 2023 18:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants