Repository navigation
Publish SLI guides as on-demand guidance with AgentDocs preview.14 - #70
Merged
Merged
Conversation
Move the three SLI packages to the redesigned guidance manifest. - Each package declares its guide as on-demand with a one-line description that says when to open it (TrellisApiRefDescription, mapped to the helper's PackageGuidanceDescription). - The guides no longer link to each other by filename. Every package installs into its own directory, so those links were broken for consumers; they now name the other packages by ID. - The guidance check expects the new manifest shape and fails if a packed guide links to a sibling package's file. - The helper is pinned to 0.1.0-preview.14. - README: consumers approve the SLI packages in .agentdocs/policy.json, then run sync; after a package upgrade, restore and sync.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #70 +/- ##
=======================================
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
🟡 Changes recommended
The sibling-reference validation misses valid ./... relative Markdown links.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Migrates SLI package guidance to the AgentDocs preview.14 on-demand manifest format.
Changes:
- Adds per-package “Open when…” guidance descriptions.
- Replaces broken cross-package documentation links with package IDs.
- Updates package validation, setup instructions, and dependency versions.
| File | Description |
|---|---|
Trellis.ServiceLevelIndicators/src/Trellis.ServiceLevelIndicators.csproj |
Adds core guidance description. |
Trellis.ServiceLevelIndicators.Asp/src/Trellis.ServiceLevelIndicators.Asp.csproj |
Adds ASP.NET Core guidance description. |
Trellis.ServiceLevelIndicators.Asp.ApiVersioning/src/Trellis.ServiceLevelIndicators.Asp.ApiVersioning.csproj |
Adds API-versioning guidance description. |
README.md |
Documents preview.14 approval and synchronization workflow. |
docs/api_reference/trellis-api-sli.md |
Replaces cross-package file links. |
docs/api_reference/trellis-api-sli-asp.md |
Replaces cross-package file links. |
docs/api_reference/trellis-api-sli-apiversioning.md |
Replaces cross-package file links. |
Directory.Packages.props |
Updates AgentDocs Packaging and Scalar versions. |
Directory.Build.targets |
Configures on-demand guidance metadata. |
build/test-guidance-packages.ps1 |
Validates the redesigned manifest and package links. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Add an "Optional AgentDocs setup" section to each package's own README, which is the page NuGet.org shows. It describes the current flow: install the pinned tool, run init, approve the packages in .agentdocs/policy.json, then sync; after an upgrade, restore and sync. The guidance check now also verifies the packed README declares the install and init commands and explains approval and sync, so a package cannot ship a page that describes the old restore-refresh flow.
The guidance check only matched links that began with the filename, so ./trellis-api-sli-asp.md, ../refs/..., links with anchors and reference-style definitions slipped through. Match any non-absolute link to a trellis-*.md file regardless of prefix or anchor, in inline and reference form; absolute URLs, in-page anchors, plain text and code spans are still allowed.
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.
What this changes
Moves the three SLI packages to the redesigned AgentDocs guidance manifest, published by
Trellis.AgentDocs.Packaging0.1.0-preview.14.TrellisApiRefDescriptionand mapped to the helper'sPackageGuidanceDescriptioninDirectory.Build.targets. No SLI guide is required reading.build/test-guidance-packages.ps1expects the new manifest shape (usage: onDemand, an "Open when..." description of at most 200 characters, noentryPoints) and fails if a packed guide links to a sibling package's reference file..agentdocs/policy.jsonand runsync; after a package upgrade they restore and sync.How it was verified
0.1.0-preview.14), andpwsh build/test-guidance-packages.ps1passes for each..agentdocs/packages/...with no relative links inside them, and headless agent sessions opened the SLI ASP guide only for the task that concerned SLI metrics.Notes
Trellis.Core.