docs(site): fix sample agent example drift from examples/sample-agent.md - #2075
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs(site): fix sample agent example drift from examples/sample-agent.md#2075github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
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. |
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.
Summary
repos: - my-org/my-repo,repos:shorthand claim) that did not match the actualexamples/sample-agent.mdfile in the repo, which still uses the legacyrepositories:+ explicittype: 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 fromexamples/sample-agent.md(legacyrepositories:form), updated the "Key features" bullet from "Repository checkout using therepos: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 therepos:shorthand, that both forms are accepted (legacy is auto-rewritten byado-aw compile), and to show the modernrepos:syntax as the recommendation for new agents — while still linking to the front-matter reference.Accuracy checks
examples/sample-agent.md(name,description,on.schedule,repositories:entry,workspace) — now byte-for-byte the same front matter.repos:vsrepositories:+checkout:behavior (auto-rewrite via codemod onado-aw compile) againstsrc/compile/codemods/0001_repos_unified.rsand the existingdocs/front-matter.mdreference, which the callout continues to link to.azure-devops-mcp.md,lean-verifier.md,dogfood-failure-reporter.md) had drift — each docs snippet was diffed against its correspondingexamples/*.mdfile and matched exactly.Validation
cd site && npm ci && npm run build:astro— full Astro build succeeds, all 38 pages generated,starlight-links-validatorreports "All internal links are valid." (The separatebuild:slidesstep 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.devTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:See Network Configuration for more information.