docs(NET-22): Bring documentation to release quality - #35
Open
cozminu wants to merge 13 commits into
Open
Conversation
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…entBase summary, OpenPaymentsOptions remarks/cref)
cozminu
changed the title
4 tasks
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.
Summary
OpenPayments.Sdkby hand-documenting all real (non-generated) public members, and scopes suppression to only the NSwag-generated model files via a targeted.editorconfigTreatWarningsAsErrorson bothOpenPayments.SdkandOpenPayments.Sdk.HttpSignatureUtilsso future undocumented members fail CI instead of silently shippingREADME.mdto each published package (Interledger.OpenPayments,Interledger.OpenPayments.HttpSignatureUtils), replacing the shared root README as the packed contentREADME.mdand points its Usage section at the new package READMEs instead of duplicating contentTest plan
dotnet build OpenPayments.Sdk/OpenPayments.Sdk.csproj -c Release— 0 Warning(s), 0 Error(s)dotnet build OpenPayments.Sdk.HttpSignatureUtils/OpenPayments.Sdk.HttpSignatureUtils.csproj -c Release— 0 Warning(s), 0 Error(s)dotnet build -c Release(whole solution) — 0 Warning(s), 0 Error(s)dotnet test— 63/63 passingdotnet packboth library projects — both nupkgs build and bundle their ownREADME.md🤖 Generated with Claude Code