Rewrite the README as a landing page and prepare 1.0.0-rc9220 - #34
Closed
ipjohnson wants to merge 1 commit into
Closed
Rewrite the README as a landing page and prepare 1.0.0-rc9220#34ipjohnson wants to merge 1 commit into
ipjohnson wants to merge 1 commit into
Conversation
The README had grown to 414 lines and duplicated most of a nineteen-page documentation site, ending in about ninety lines of dumped generated code. It now leads with the pitch, shows what the library looks like in use, and then walks through what you can actually do with it — conventions, decorators and interception, environment conditions, testing with mocks, trimming and AOT, build-time diagnostics — each with a short example and a link to the page that goes deep. Everything the site covers better is a link rather than a section. Every link is absolute. The README is packed into all nine packages and is the listing page on nuget.org, where relative links do not resolve; the changelog link, the licence link and the licence badge were all broken there. Sidebar section "Registering in bulk" becomes "Bulk Registration". Rolls the changelog's Unreleased section into 1.0.0-rc9220, matching how rc9210 was cut. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_013me9Eodb4PjJgR4ZNKrC9B
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.
README
The README had grown to 414 lines and duplicated most of a nineteen-page documentation site, ending in roughly ninety lines of dumped generated code. It is now 213 lines and works as a landing page: the pitch, the problem it solves, what the library looks like in use, and then a walk through what you can actually do with it.
Each feature gets a short real example and a link to the page that goes deep:
Mock<T>taken directly as a parameterEverything the site covers better is now a link rather than a section: realms, keyed registration,
As,Try/Replace/TryEnumerable, module features, duplicate-registration handling, parameters, factories, autogenerated modules, and the three-step diagnostic walkthrough. The generated-code dump is replaced by two representative lines, which makes the same point without the wall ofglobal::qualifiers.All sixteen documentation links were checked against the live site and return 200.
Links are absolute now
The README is packed into all nine packages and is the listing page on nuget.org, where relative links do not resolve. The changelog link, the licence link and the licence badge were all relative and rendering broken there. There are no relative links left.
Sidebar
"Registering in bulk" becomes "Bulk Registration".
Release prep
The changelog's
Unreleasedsection is rolled into1.0.0-rc9220, matching how rc9210 was cut — no[Unreleased]heading remains at a release tag. Merging this is the last step before tagging.🤖 Generated with Claude Code
https://claude.ai/code/session_013me9Eodb4PjJgR4ZNKrC9B