Documentation in preparation for a release

[djthorpe]

This PR enhances documentation across the codebase in preparation for a release. It improves godoc comments to follow Go conventions, adds package-level documentation, and includes comprehensive README files and code examples.

• Updates function and type comments to follow Go documentation standards (capitalization and complete sentences)
• Adds package documentation files (doc.go) for major packages
• Includes new README files with usage examples for the manager and test packages

[Copilot]

Pull request overview

This PR enhances documentation across the codebase in preparation for a release. It improves godoc comments to follow Go conventions, adds package-level documentation, and includes comprehensive README files and code examples.

• Updates function and type comments to follow Go documentation standards (capitalization and complete sentences)
• Adds package documentation files (doc.go) for major packages
• Includes new README files with usage examples for the manager and test packages

Reviewed changes

Copilot reviewed 34 out of 35 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
tracer.go	Enhanced godoc comment for NewTracer
schema.go	Added godoc comments for schema management functions
pool.go	Improved godoc comment for NewPool
pkg/version/doc.go	Added package documentation
pkg/types/doc.go	Added package documentation
pkg/test/postgresql.go	Enhanced godoc comment for NewPgxContainer
pkg/test/main.go	Updated godoc comment for Close method
pkg/test/doc.go	Rewrote package documentation for clarity
pkg/test/container.go	Improved godoc comment for NewContainer
pkg/test/README.md	Added comprehensive testing documentation
pkg/manager/schema/object_test.go	Added test coverage for TableMeta and Object with table metadata
pkg/manager/schema/object.go	Added TableMeta type and integrated table statistics from pg_stat_user_tables
pkg/manager/schema/doc.go	Added package documentation
pkg/manager/schema/acl.go	Enhanced godoc comments for ACL functions
pkg/manager/manager.go	Updated godoc comment and removed unused withExtensions method
pkg/manager/httphandler/metrics.go	Added Prometheus metrics handler for PostgreSQL monitoring
pkg/manager/httphandler/httphandler.go	Registered metrics handler
pkg/manager/httphandler/doc.go	Added package documentation
pkg/manager/httpclient/opts.go	Enhanced godoc comments
pkg/manager/httpclient/doc.go	Added package documentation
pkg/manager/httpclient/client.go	Improved godoc comment for New
pkg/manager/doc.go	Added comprehensive package documentation
pkg/manager/README.md	Added detailed manager package documentation
opts.go	Enhanced godoc comments for option functions
offsetlimit.go	Improved godoc comments
listener.go	Fixed potential deadlock in WaitForNotification
go.mod	Added prometheus client_golang dependency
example/name.go	Fixed error message capitalization
example/ingest.go	Fixed error message capitalization
err.go	Added godoc comments for error methods
doc.go	Added comprehensive package documentation
conn.go	Enhanced godoc comments for types and interfaces
bind.go	Improved godoc comments and fixed lock usage in Append method
README.md	Expanded with detailed examples and feature documentation

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.