Skip to content

docs(site): fix sample agent example drift from examples/sample-agent.md - #2075

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-sample-agent-example-drift-1a3ddb3016316316
Draft

docs(site): fix sample agent example drift from examples/sample-agent.md#2075
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-sample-agent-example-drift-1a3ddb3016316316

Conversation

@github-actions

@github-actions github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • The "Sample agent" section on the [Example agents]((githubnext.github.io/redacted) docs page showed a fabricated YAML snippet (repos: - my-org/my-repo, repos: shorthand claim) that did not match the actual examples/sample-agent.md file in the repo, which still uses the legacy repositories: + explicit type: git / name: form with a different agent name and repo alias. Anyone copy-pasting from the docs or clicking through to the linked file would find a mismatch.

Changes

  • site/src/content/docs/guides/examples.mdx: replaced the fabricated snippet with the real front matter from examples/sample-agent.md (legacy repositories: form), updated the "Key features" bullet from "Repository checkout using the repos: shorthand" to "Explicit repository checkout" (accurate for what the file does), and reworked the :::tip[repos: shorthand] callout to explain that this specific example predates the repos: shorthand, that both forms are accepted (legacy is auto-rewritten by ado-aw compile), and to show the modern repos: syntax as the recommendation for new agents — while still linking to the front-matter reference.

Accuracy checks

  • Diffed the docs snippet directly against examples/sample-agent.md (name, description, on.schedule, repositories: entry, workspace) — now byte-for-byte the same front matter.
  • Confirmed repos: vs repositories: + checkout: behavior (auto-rewrite via codemod on ado-aw compile) against src/compile/codemods/0001_repos_unified.rs and the existing docs/front-matter.md reference, which the callout continues to link to.
  • No other example section (azure-devops-mcp.md, lean-verifier.md, dogfood-failure-reporter.md) had drift — each docs snippet was diffed against its corresponding examples/*.md file and matched exactly.

Validation

  • cd site && npm ci && npm run build:astro — full Astro build succeeds, all 38 pages generated, starlight-links-validator reports "All internal links are valid." (The separate build:slides step failed only due to a sandboxed-network Playwright browser download being blocked, unrelated to this change.)

Created by the docs-writer workflow.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • cdn.playwright.dev

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "cdn.playwright.dev"

See Network Configuration for more information.

Generated by Docs Writer · auto · 126.8 AIC · ⌖ 7.82 AIC · ⊞ 12.1K ·

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
2 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants