Finding package guidance: fetch it with dotnet-inspect
When you must use a NuGet package's API and want authoritative, version-specific guidance,
fetch the package's own shipped docs with the dotnet-inspect CLI instead of guessing or
relying on possibly-stale training memory.
dotnet-inspect is a global .NET tool already on your PATH. It reads the package (from the
restored NuGet cache or the feed) and prints its documentation. It does HTTP itself; you do
not need a web tool.
Workflow when you must use a package whose API you are unsure of:
Identify the package id and the exact version from the project (
PackageReference/Directory.Packages.props) — e.g.Markout0.13.6. Always pass the referenced version so you read the docs for the version the project actually uses.Fetch the package's best doc:
dotnet-inspect package <id>@<version> --readme--readmereturns the single best shipped doc, preferring a short, agent-targeted one overREADME.md(long, human-oriented) overPACKAGE.md. Follow it directly — it is written for the version you are on.
This keeps you on the package's intended, current API for the exact version referenced, and avoids reconstructing it from training memory or mining a long README.