Rewrite the README around a runnable quick start - #5
Merged
Merged
Conversation
…ocs to docs/ The old Quick Start could not be followed as written: only a prerelease is on NuGet, so `dotnet add package` without --prerelease fails, and the snippet used an AppDbContext it never defined. The new README leads with a single-file EF Core + SQLite app that was verified against the published 1.0.0-preview.1 packages, then links out to per-topic pages under docs/. docs/validation.md now states that Data Annotations are only enforced by the REST endpoint, not by SetAsync(), and adds the FluentValidation package install step. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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.
Why
New users couldn't get started from the README:
1.0.0-preview.1is on NuGet, sodotnet add package DotNetBoost.Settings.Coreerrors with "There are no stable versions available".AppDbContextit never defined, had nousinglines, and needed EF migrations.What changed
Program.csplus threecurlcommands that change a setting while the app runs. After that:docs/, with nothing removed. There are 13 topic pages plus an index atdocs/README.md. Relative paths and cross-page anchors are fixed.PackageReadmeFile) and relative links break on nuget.org.--prereleaseis on every install command.docs/storage-providers.mdnow has the install commands andusinglines each provider needs.docs/validation.md:DotNetBoost.Settings.FluentValidationinstall stepPOST, not bySetAsync(). The code change to fix that is a separate follow-up.Verification
I ran the quick start exactly as written in a fresh
dotnet new webproject against the published1.0.0-preview.1packages:smtp.example.com:587204smtp.mycompany.com:2525smtp.mycompany.com:2525Every relative link under
docs/resolves. Note that nuget.org keeps showing the old readme until the next package is published.🤖 Generated with Claude Code