docs: standardize README to match other ParadeDB ORM repos - #35
Merged
Conversation
Match the format used by django-paradedb, sqlalchemy-paradedb, and rails-paradedb so the ParadeDB ORM family presents consistently: - Replace the local logo (assets/paradedb-logo.png) with the canonical ParadeDB readme SVG hosted in paradedb/paradedb. - Add the tagline, top nav (Website / Docs / Community / Blog / Changelog), and the standard badge row (NuGet version, .NET versions, NuGet downloads, Codecov, License, Slack, Twitter). - Switch the intro to the "ParadeDB for X" pattern with a single paragraph that links to the docs getting-started anchor. - Drop the Configuration code snippet and Function Mappings table from the README — keep the README short and link to docs; the Function Mappings table is still in NUGET-README.md for the package page. - Update Requirements & Compatibility table to add EF Core row.
philippemnoel
requested review from
isaacvando,
mdashti,
rebasedming and
stuhood
as code owners
May 12, 2026 23:38
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
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
Brings the
efcore-paradedbREADME in line with the format used bydjango-paradedb,sqlalchemy-paradedb, andrails-paradedbso the ORM family presents consistently.Header / branding
assets/paradedb-logo.pngheading with the canonical ParadeDB readme SVG hosted inparadedb/paradedb.Body
#efcore).NUGET-README.md(the package page), and configuration details belong on docs.paradedb.com.Notes / follow-ups not in this PR
.NETcoverage step inci.ymlyet).#efcoreondocs.paradedb.com/documentation/getting-started/environmentmay not exist yet; matches the convention used by the other ORMs (#django,#sqlalchemy,#rails). Update if the canonical anchor differs.assets/paradedb-logo.pngis now unreferenced by the README but kept on disk — it's still packed into the NuGet package viasrc/Directory.Build.props(<PackageIcon>paradedb-logo.png</PackageIcon>).Test plan
lint-markdownworkflow passes