docs: integrate Quick Start guide and documentation into README - #2632
Merged
jackc merged 3 commits intoAug 24, 2026
Conversation
Link pkg.go.dev, the getting started wiki, and connection string docs so API reference is easy to find without relying on the badge alone. Signed-off-by: Vedant Madane <6527493+VedantMadane@users.noreply.github.com>
Owner
|
I don't mind making some changes here, but having the link to the Getting Started wiki page repeated twice in 6 lines doesn't fill me with confidence are the right changes. If I were to change something I would probably integrate a quick start guide into the README. |
- Add installation instructions (`go get github.com/jackc/pgx/v5`) - Group basic example and connection configuration under Quick Start - Provide structured Documentation links for pgx, pgxpool, and stdlib - Avoid duplicate links to the Getting Started wiki page Signed-off-by: Vedant Madane <6527493+VedantMadane@users.noreply.github.com>
Signed-off-by: Vedant Madane <6527493+VedantMadane@users.noreply.github.com>
Contributor
Author
|
I have updated the README to integrate a Quick Start section (installation, usage example and connection string configuration) and a Documentation section pointing to the pgx, pgxpool, and stdlib pkg.go.dev docs removing the wiki link. Pushed in commit c26469b. |
VedantMadane
changed the title
VedantMadane
force-pushed
the
docs/readme-documentation-section
branch
from
August 22, 2026 13:20
c26469b to
3bfc268
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a text Documentation section to the README with links to:
pgconn.ParseConfigdocs (URL and keyword/value forms)Makes the docs discoverable beyond the small pkg.go.dev badge.
Fixes #669