Skip to content

docs: refresh README#52

Merged
gordonmurray merged 1 commit into
lance-format:mainfrom
gordonmurray:docs/51-readme-refresh
Jun 10, 2026
Merged

docs: refresh README#52
gordonmurray merged 1 commit into
lance-format:mainfrom
gordonmurray:docs/51-readme-refresh

Conversation

@gordonmurray

Copy link
Copy Markdown
Collaborator

Summary

Brings the README back in line with the code.

Corrections:

Consistency and additions:

  • 0.29.2 is now the recommendation everywhere; the tip and the docker-compose example still pointed at 0.24.3.
  • Documented the image tags added in chore: centralize app version and publish release artifacts #46 (latest, stable, v{app version}, app-{version}_lancedb-{version}) so users can pin to an app release.
  • Added a section on running the test suite locally.
  • Linked CONTRIBUTING.md and CHANGELOG.md, and tidied the header.

Test plan

  • Checked each claim against the code: vector handling in backend/app.py, the constraints files, and the tag rules in .github/workflows/release.yml
  • Test suite instructions are the same commands CI runs, verified earlier on all six constraints files
  • Relative links resolve (CONTRIBUTING.md and CHANGELOG.md are at the repo root)

Fixes #51

Corrects claims that drifted from the code: variable-length float
vectors render fully since lance-format#14 (the old text said schema-only with
corruption warnings), there is no 2048-dimension preview limit, and
the 0.29.2 image installs pyarrow >=16,<22 rather than a single
pinned version.

Makes 0.29.2 the recommendation throughout (the tip and the compose
example still pointed at 0.24.3), documents the release image tags
added in lance-format#46 (latest, stable, v{version}, app-{version}_lancedb-{v}),
adds instructions for running the test suite from lance-format#28, and links
CONTRIBUTING.md and CHANGELOG.md.

Fixes lance-format#51
@gordonmurray gordonmurray merged commit 559d07c into lance-format:main Jun 10, 2026
18 of 24 checks passed
@gordonmurray gordonmurray deleted the docs/51-readme-refresh branch June 10, 2026 18:48
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.

docs: refresh README

1 participant