-
Notifications
You must be signed in to change notification settings - Fork 740
docs: Update root README with new links and modules #2559
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good, thanks for the much needed update 🙏
Just a few comments on the Contributing/ Support sections.
README.md
Outdated
|
||
Check out the [samples](samples/README.md) for a quick start. | ||
## Reporting Issues / Support |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd say reporting issues is a form of contributing. So the first section can go under ## Contributing ### Reporting issues
. And the second section into a separate ## Support
chapter.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let me know if this looks better now
- Add links to Exposed website - Edit intro to mention R2DBC support - Replace majority of dependency section with link to identical details in docs - Add full module list with missing dependencies - Move tutorial link to samples section - Replace links section with documentation and remove duplicates - Replace community section with reporting and support and move issue tracker there - Fix incorrect import paths in examples - Minor adjustments to sample code - Make SQL output actually accurate
Co-authored-by: Vik Nikolova <[email protected]>
- Apply suggestions to contribution/support section
7ca7b29
to
2c79bd4
Compare
Description
Summary of the change: Update content of project README to match V1 changes to modules, packages, and associated links.
Detailed description:
Type of Change