Repository navigation
docs: enforce XML documentation and add package metadata - #33
Merged
Merged
Conversation
Remove CS1591 from the repo-wide NoWarn and suppress it only in the non-shipped projects. Add PackageProjectUrl, update the .NET badge to the shipped targets, and add the Documentation section to AGENTS.md. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
There was a problem hiding this comment.
🟢 Approval recommended
The metadata, warning configuration, documentation, and framework badge changes are consistent across the repository.
0 open findings
What changed in this PR
Enforces XML documentation for shipped libraries and improves package/readme metadata.
Changes:
- Enforces
CS1591for source projects while exempting tests and build tooling. - Adds the documentation site as the NuGet project URL.
- Updates contributor guidance and supported-framework badge.
| File | Description |
|---|---|
Directory.Build.props |
Enables documentation warnings and adds package URL metadata. |
tests/Invex.Rez.Tests/Invex.Rez.Tests.csproj |
Suppresses documentation warnings for tests. |
_atom/_atom.csproj |
Suppresses documentation warnings for build tooling. |
README.md |
Updates the framework badge. |
AGENTS.md |
Documents XML and documentation-site conventions. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
Requested by Dec · project thread
Before:
CS1591was suppressed repo-wide, there was no project URL, and the README badge listed .NET 8 and 9.After: a new undocumented public member fails the build,
PackageProjectUrlpoints at the docs site, and the badge shows .NET 10.0 and .NET Standard 2.0. AGENTS.md has a Documentation section and no longer says CS1591 is suppressed.This is steps 6 and 7 of the shared Invex documentation standard.
How: removed
CS1591fromDirectory.Build.props._atomand the test project now suppress it in their own csproj.srcneeded no new docs.Local check: the build passes, and all tests pass (89).
🤖 Generated with Claude Code
https://claude.ai/code/session_01Jy23TCq1bZkdPV2GRWfspU
Generated by Claude Code