Skip to content

Upgrade AgentDocs packaging to preview 22 #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
xavierjohn merged 1 commit into from
Oct 17, 2026
Merged

Upgrade AgentDocs packaging to preview 22 #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<PackageVersion Include="Asp.Versioning.Mvc.ApiExplorer" Version="10.2.1" />
<PackageVersion Include="Asp.Versioning.OpenApi" Version="10.2.3" />
<PackageVersion Include="DotNet.ReproducibleBuilds" Version="2.0.5" />
<PackageVersion Include="Trellis.AgentDocs.Packaging" Version="0.1.0-preview.20" />
<PackageVersion Include="Trellis.AgentDocs.Packaging" Version="0.1.0-preview.22" />
<PackageVersion Include="Microsoft.AspNetCore.OpenApi" Version="10.0.13" />
<PackageVersion Include="Microsoft.AspNetCore.TestHost" Version="10.0.13" />
<PackageVersion Include="Microsoft.Extensions.Configuration.Json" Version="10.0.13" />
Expand Down
4 changes: 2 additions & 2 deletions Trellis.ServiceLevelIndicators.Asp.ApiVersioning/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ run from its Git root:

```powershell
dotnet new tool-manifest --output .config
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.20 --tool-manifest .config/dotnet-tools.json
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.22 --tool-manifest .config/dotnet-tools.json
dotnet tool run agentdocs init <solution-or-project>
```

Expand All @@ -72,7 +72,7 @@ lists `Trellis.ServiceLevelIndicators.Asp.ApiVersioning` as pending and prints t
`dotnet tool run agentdocs sync` to install the guides under Git-root
`.agentdocs/`. The guide is on-demand: the generated index describes it, and an
agent opens it when its task concerns SLI metrics. After a package upgrade, run
`dotnet restore` and then `dotnet tool run agentdocs sync`.
`dotnet restore --force` and then `dotnet tool run agentdocs sync`.

## Further Reading

Expand Down
4 changes: 2 additions & 2 deletions Trellis.ServiceLevelIndicators.Asp/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@ run from its Git root:

```powershell
dotnet new tool-manifest --output .config
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.20 --tool-manifest .config/dotnet-tools.json
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.22 --tool-manifest .config/dotnet-tools.json
dotnet tool run agentdocs init <solution-or-project>
```

Expand All @@ -308,7 +308,7 @@ lists `Trellis.ServiceLevelIndicators.Asp` as pending and prints the package IDs
`dotnet tool run agentdocs sync` to install the guides under Git-root
`.agentdocs/`. The guide is on-demand: the generated index describes it, and an
agent opens it when its task concerns SLI metrics. After a package upgrade, run
`dotnet restore` and then `dotnet tool run agentdocs sync`.
`dotnet restore --force` and then `dotnet tool run agentdocs sync`.

## Further Reading

Expand Down
4 changes: 2 additions & 2 deletions Trellis.ServiceLevelIndicators/src/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ run from its Git root:

```powershell
dotnet new tool-manifest --output .config
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.20 --tool-manifest .config/dotnet-tools.json
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.22 --tool-manifest .config/dotnet-tools.json
dotnet tool run agentdocs init <solution-or-project>
```

Expand All @@ -213,7 +213,7 @@ lists `Trellis.ServiceLevelIndicators` as pending and prints the package IDs to
`dotnet tool run agentdocs sync` to install the guides under Git-root
`.agentdocs/`. The guide is on-demand: the generated index describes it, and an
agent opens it when its task concerns SLI metrics. After a package upgrade, run
`dotnet restore` and then `dotnet tool run agentdocs sync`.
`dotnet restore --force` and then `dotnet tool run agentdocs sync`.

## Further Reading

Expand Down
4 changes: 2 additions & 2 deletions docs/usage-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -542,13 +542,13 @@ Ordinary restore/build does not write `.github/`, `AGENTS.md`, or `.agentdocs/`

```powershell
dotnet new tool-manifest --output .config
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.20 --tool-manifest .config\dotnet-tools.json
dotnet tool install Trellis.AgentDocs --version 0.1.0-preview.22 --tool-manifest .config\dotnet-tools.json
dotnet tool run agentdocs init <solution-or-project>
```

Reuse an existing root `.config\dotnet-tools.json` instead of creating another. Restoring a package never activates its guide. `init` lists packages that publish guidance as pending and prints the package IDs to add to `approvedPackages` in `.agentdocs/policy.json`. Add the SLI packages you trust, then run `dotnet tool run agentdocs sync` to install their guides into Git-root `.agentdocs/`; `init` also adds managed instruction pointers.

Guides are on-demand: the generated index lists each with a description, and an agent opens one when its task concerns SLI metrics. After a package upgrade, run `dotnet restore` and `dotnet tool run agentdocs sync`. The helper and tool are preview packages published on NuGet.org.
Guides are on-demand: the generated index lists each with a description, and an agent opens one when its task concerns SLI metrics. After a package upgrade, run `dotnet restore --force` and `dotnet tool run agentdocs sync`. The forced restore refreshes NuGet's successful-restore checkpoint even when the resolved graph stays unchanged; the tool rejects stale restore output rather than installing outdated guidance. The helper and tool are preview packages published on NuGet.org.

For maintainers, the three publishing projects use a pinned, private `Trellis.AgentDocs.Packaging` build dependency to generate manifests at pack time. Each project sets `TrellisApiRefDescription`, the one-line "Open when..." topic consumers see. Guides refer to sibling packages by ID rather than by link because every package installs into its own directory. The packaging build target is not included in published SLI packages. Run `pwsh -NoProfile -File build\test-guidance-packages.ps1` after packing to verify payloads and the absence of legacy consumer targets.

Expand Down
Loading