Skip to content

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

bog-walk
Copy link
Member

Description

Summary of the change: Update content of project README to match V1 changes to modules, packages, and associated links.

Detailed description:

  • Why: It was brought up that many of the new-ish packages are not listed, nor are new site links, and some current content is broken/incorrect.
  • What:
    • 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 dependencies that were missing
    • Move tutorial link to samples section
    • Replace links section with documentation, remove duplicates, and fix broken url
    • Replace community section with reporting and support and move details about issue tracker there
    • Fix incorrect import paths in example code
    • Minor adjustments to example code to make more legible
    • Make SQL output an accurate match (for H2 used)

Type of Change

  • Documentation update

@bog-walk bog-walk requested a review from vnikolova July 17, 2025 00:02
Copy link
Collaborator

@vnikolova vnikolova left a 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
Copy link
Collaborator

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.

Copy link
Member Author

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

bog-walk and others added 3 commits July 25, 2025 02:36
- 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
- Apply suggestions to contribution/support section
@bog-walk bog-walk force-pushed the bog-walk/update-readme branch from 7ca7b29 to 2c79bd4 Compare July 25, 2025 06:44
@bog-walk bog-walk requested a review from vnikolova July 25, 2025 06: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