docs: shorten README tagline and use "X+" version format - #37
Merged
Conversation
Match the django-paradedb / sqlalchemy-paradedb / rails-paradedb phrasing and table format so the ORM family stays consistent. - Tagline: drop the "built on top of Npgsql.EntityFrameworkCore..." and "EF.Functions / LINQ-based" details — those belong on docs. New phrasing mirrors django: "first-class support for managing BM25 indexes and running queries using the full ParadeDB API." - Requirements table: switch to "X+" (8+ instead of "8, 9, 10") for .NET and EF Core, matching how Python/Django are listed. - Drop the documented minimum ParadeDB version from 0.23.0 to 0.22.0 to align with the other ORMs. Update README, NUGET-README, and RELEASE.md in sync. scripts/run_paradedb.sh and the CI service image stay on 0.23.0: they pin a specific version for local dev and integration tests, which is independent of the documented minimum supported version.
philippemnoel
requested review from
isaacvando,
mdashti,
rebasedming and
stuhood
as code owners
May 12, 2026 23:58
efcore-paradedb is a community-contributed integration that ParadeDB just imported. Mark it explicitly as not yet ready for public consumption so users understand the stability bar before depending on it.
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
1 participant
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
Align the README tagline and Requirements & Compatibility table with
django-paradedb/sqlalchemy-paradedb/rails-paradedbso the ORM family stays consistent.Tagline
Was:
Now:
Mirrors the django phrasing; the Npgsql /
EF.Functions/ LINQ details belong on docs.paradedb.com, not the front-page README.Requirements & Compatibility
Switch the version columns to the same
X+shape Django uses, instead of enumerating every supported major:NUGET-README.mdtable updated the same way (and gains the missing EF Core row).ParadeDB minimum: 0.23.0 → 0.22.0
Matches the documented minimum used by django-paradedb, sqlalchemy-paradedb, and rails-paradedb. Updated in:
README.md(Requirements & Compatibility table)NUGET-README.md(same table)RELEASE.md("maintained minimum ParadeDB version" line and the compatibility-targets list)Intentionally not changed
scripts/run_paradedb.shkeepsPARADEDB_VERSION=0.23.0— that's a pinned default for the local dev container.paradedb/paradedb:0.23.0-pg18— integration tests pin a specific version for reproducibility. The documented minimum supported version is a separate concern from what CI happens to test against. If we want CI to also cover the 0.22.0 floor, that's a follow-up (add another matrix entry inci.yml).Test plan
lint-markdownworkflow passes