Docs: bring README and CHANGELOG up to date with what ships - #1
Open
dmitrat wants to merge 1 commit into
Open
Conversation
The docs stopped tracking the code at 2.3.0; three releases and a package have shipped since. CHANGELOG - Adds 2.3.1, 2.3.2 and 2.3.3, which were missing entirely while published on NuGet. The version-to-commit mapping is not inferred from dates alone: <Version> was read out of Communication/OutWit.Communication/OutWit.Communication.csproj at each commit, and the dates are the packages' published timestamps. - 2.3.0 was dated "2025-01-XX" (placeholder) and 2.2.0 "Previous Release"; both now carry their real release dates, 2025-12-09 and 2025-11-14. README - OutWit.Communication.Client.Blazor was absent from the package table although it ships since 2.3.2. The Blazor section also showed only the manual BouncyCastle route; it now leads with AddWitRpcChannel, the API the package actually exposes. - Service discovery was missing from the feature list despite being in the code (DiscoveryClient/DiscoveryServer plus per-transport DiscoveryUtils). InterProcess READMEs - All three documented an API that does not exist — WitProcessHost.Launch<T>() and WitProcessAgent.Run(), names that appear nowhere in the source — under a disclaimer reading "The actual API calls in the library may differ". Replaced with text built on the real entry points: HostManager, HostAgent, AgentApplication, AgentStartupParameters, HostUtils. Also adds @*/ to .gitignore: @-prefixed folders are working directories. Co-Authored-By: Claude Opus 5 (1M context) <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
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.
The docs stopped tracking the code at 2.3.0; three releases and a package have shipped since.
CHANGELOG
<Version>was read out ofCommunication/OutWit.Communication/OutWit.Communication.csprojat each commit, and the dates are the packages' published timestamps.<Version>08422968b8501ccb4a68d2025-01-XX(placeholder) and 2.2.0Previous Release; both now carry their real dates — 2025-12-09 and 2025-11-14.README
OutWit.Communication.Client.Blazorwas absent from the package table although it ships since 2.3.2. All 22 packages are now listed.AddWitRpcChannel, checked againstServiceCollectionExtensionsin the package.DiscoveryClient/DiscoveryServerplus per-transportDiscoveryUtils).InterProcess READMEs
All three documented an API that does not exist:
WitProcessHost.Launch<T>()andWitProcessAgent.Run()appear nowhere in the source, under a disclaimer reading "The actual API calls in the library may differ, but the concept remains". NeitherHostManagernorAgentApplicationwas mentioned in any markdown file in the repository.Replaced with the prepared text built on the real entry points:
HostManager,HostAgent,AgentApplication,AgentStartupParameters,HostUtils.Also
@*/added to.gitignore—@-prefixed folders are working directories.Note that these READMEs are packed into the NuGet packages, so the corrected text reaches nuget.org on the next publish of the affected packages.
🤖 Generated with Claude Code