Repository navigation
Show AgentDocs setup on SLI NuGet package pages - #69
Closed
xavierjohn wants to merge 1 commit into
Closed
xavierjohn wants to merge 1 commit into
xavierjohn wants to merge 1 commit into
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #69 +/- ##
=======================================
Coverage 83.17% 83.17%
=======================================
Files 23 23
Lines 434 434
Branches 70 70
=======================================
Hits 361 361
Misses 56 56
Partials 17 17 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
The documentation and package validation changes consistently satisfy the stated purpose.
Review effort: Balanced
Findings: None
What changed in this PR
Adds opt-in AgentDocs setup instructions to each NuGet-visible package README and validates the packed documentation.
Changes:
- Documents AgentDocs installation and initialization for all three packages.
- Validates packed NuGet readme metadata, file presence, and required commands.
| File | Description |
|---|---|
Trellis.ServiceLevelIndicators/src/README.md |
Adds core-package AgentDocs setup. |
Trellis.ServiceLevelIndicators.Asp/src/README.md |
Adds ASP package AgentDocs setup. |
Trellis.ServiceLevelIndicators.Asp.ApiVersioning/src/README.md |
Adds API-versioning package setup. |
build/test-guidance-packages.ps1 |
Validates packed README metadata and commands. |
💡 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.
Summary
README.mdas its NuGet readme and includes the install/init commands.The repository-root README already documented setup, but NuGet displays the separate README shipped inside each nupkg. Existing releases cannot be edited; a subsequent package release will display the new instructions.
Validation
dotnet pack --no-build -c Releaseandbuild/test-guidance-packages.ps1(three packages passed)