docs(readme): fix package-split drift (EF/Postgres is its own package)#177
Merged
Conversation
The getting-started and project-layout sections still claimed the Postgres/EF backend ships inside core Argus.Sync, contradicting the migration table (which already documents the split). Aligned them to the example project: - install: add Argus.Sync.EntityFramework (core is storage-agnostic now) - DbContext example: using Argus.Sync.Data -> Argus.Sync.EntityFramework (where CardanoDbContext lives) - register example: add the Argus.Sync.EntityFramework using for AddCardanoPostgresIndexer - Storage Backends: 'The default' -> 'Add the package'; per-branch -> batched - Project Layout: corrected core's description + added the Argus.Sync.EntityFramework row - pack commands: added Argus.Sync.EntityFramework - minor 1.2 terminology (pipeline -> graph processor, branch -> batch) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the repository README to reflect the current NuGet package split, clarifying that the EF Core/PostgreSQL backend lives in Argus.Sync.EntityFramework rather than the core Argus.Sync package.
Changes:
- Updates getting-started install and code snippets to reference
Argus.Sync.EntityFrameworkfor EF/Postgres (CardanoDbContext,AddCardanoPostgresIndexer). - Clarifies storage-backend wording and 1.2 terminology (pipeline/branch → graph processor/batch).
- Updates packaging and project layout documentation to include
Argus.Sync.EntityFramework.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+84
to
88
| # PostgreSQL backend (Entity Framework Core) + EF tooling for migrations | ||
| dotnet add package Argus.Sync.EntityFramework | ||
| dotnet add package Microsoft.EntityFrameworkCore.Design | ||
| dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL | ||
|
|
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.
Aligns the getting-started + project-layout sections with the actual package split — the EF/Postgres backend lives in
Argus.Sync.EntityFramework, not coreArgus.Sync. These sections contradicted the migration table (which already documents the split); now grounded in the example project.Argus.Sync.EntityFramework; core marked storage-agnosticusing Argus.Sync.Data→using Argus.Sync.EntityFramework(whereCardanoDbContextlives)Argus.Sync.EntityFrameworkusing forAddCardanoPostgresIndexerArgus.Sync.EntityFrameworkrow addedDocs-only — no code changes.
🤖 Generated with Claude Code