Skip to content

docs: add integration guides and simplify latest release installation - #53

Merged
alberttwong merged 1 commit into
mainfrom
codex/data-tool-guides-latest-install
Nov 2, 2026
Merged

alberttwong merged 1 commit into
mainfrom
codex/data-tool-guides-latest-install

Conversation

@alberttwong

Copy link
Copy Markdown
Collaborator

The README previously mixed client examples, overlapping compatibility summaries, and release commands that required manually choosing a version and platform. It now links every data tool to a setup guide and installs the latest published release by default.

  • Add a shared prerequisites/sample-data guide and individual guides for Python, Go, Java, JDBC applications, pandas, Polars, DuckDB, R, Tableau, Metabase, Power BI, and Redis Insight; reuse the existing DBeaver and version-specific Superset guides. Preserve recorded validation scope, blockers, and untested paths.
  • Remove the README client examples and separate tested-coverage/feature sections, retaining a concise capability overview and links to the compatibility and protocol references. Repair links to removed sections.
  • Use Docker :latest with --pull=always; detect the binary platform, resolve the latest release tag, and verify the archive checksum before starting the server.

Validation: local Markdown links and anchors checked across 18 files; all 14 README tool links verified; README shell and Python snippet syntax checked; Go example compiled; git diff --check passed. Java compilation could not run because no JDK is installed. No integration suites or application tests were rerun, and no new compatibility passes are claimed.

The latest-release metadata identified v0.1.0, but its download assets had not yet been attached when checked. The install section explains artifact publication and the source-build fallback; release installation was not exercised end to end.

@alberttwong
alberttwong merged commit c019afc into main Nov 2, 2026
1 check passed
@alberttwong
alberttwong deleted the codex/data-tool-guides-latest-install branch November 2, 2026 04:28
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.

1 participant