Skip to content

docs: fix documentation drift — add .NET runtime across all docs #475

@github-actions

Description

@github-actions

Documentation Freshness Audit

This audit found the following inconsistencies between code and documentation:

Findings

Area Issue File(s)
Architecture tree dotnet/ runtime directory missing from runtimes/ section AGENTS.md
Docs index docs/runtimes.md entry lists "Lean 4, Python, Node.js" but omits .NET AGENTS.md
Front matter table runtimes field description shows only "lean" README.md
Workflow authoring prompt No runtimes step — agents authoring pipelines have no guidance on runtimes: configuration prompts/create-ado-agentic-workflow.md

Details

src/runtimes/dotnet/ exists in the codebase (with mod.rs and extension.rs) and DotnetRuntimeConfig is a fully documented field in FrontMatter. The runtime is also covered in docs/runtimes.md. However, three other documentation surfaces hadn't been updated:

  1. AGENTS.md architecture tree — The runtimes/ subtree listed only lean/, python/, and node/; dotnet/ was absent.
  2. AGENTS.md docs index — The blurb for docs/runtimes.md said "Lean 4, Python, Node.js" with no mention of .NET.
  3. README.md front matter table — The runtimes row description said only "lean" instead of listing all supported runtimes.
  4. prompts/create-ado-agentic-workflow.md — No "Runtimes" step existed in the workflow creation guide (Steps 1–13 skipped runtimes entirely). AI agents following this guide would never know to configure runtimes: even when the task clearly needs it (e.g., .NET dependency update agent).

Applied Fixes

  • Added dotnet/ subtree to the runtimes/ architecture section in AGENTS.md
  • Updated docs/runtimes.md docs-index description in AGENTS.md to include ".NET"
  • Updated runtimes field description in README.md to list lean, python, node, dotnet
  • Added Step 13 — Runtimes (optional) to prompts/create-ado-agentic-workflow.md with YAML examples for all four runtimes (lean, python, node, dotnet) and a note about auto-added bash commands and network domains; renumbered former Step 13 → Step 14 (Network)

This pull request was created by the automated documentation freshness check.


Warning

Protected Files

This was originally intended as a pull request, but the patch modifies protected files. These files may affect project dependencies, CI/CD pipelines, or agent behaviour. Please review the changes carefully before creating the pull request.

Click here to create the pull request once you have reviewed the changes

Protected files
  • AGENTS.md

To route changes like this to a review issue instead of blocking, configure protected-files: fallback-to-issue in your workflow configuration.

Generated by Documentation Freshness Check · ● 2M ·

Metadata

Metadata

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions