Skip to content

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

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

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

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

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
17 changes: 13 additions & 4 deletions site/src/content/docs/guides/examples.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A minimal example demonstrating the basic structure of an agent file.

**Key features:**
- Simple daily schedule trigger
- Repository checkout using the `repos:` shorthand
- Explicit repository checkout
- Basic workspace setup
- Straightforward agent prompt

Expand All @@ -27,8 +27,10 @@ name: "Daily Code Review"
description: "Reviews code changes and creates summary reports"
on:
schedule: daily
repos:
- my-org/my-repo
repositories:
- repository: azure-devops-agentic-pipelines
type: git
name: azure-devops-agentic-pipelines
workspace: repo
---

Expand All @@ -44,7 +46,14 @@ Review the latest code changes in the repository and provide feedback.
```

:::tip[repos: shorthand]
`repos:` is the current recommended syntax for repository checkout. The legacy `repositories:` format is automatically rewritten to `repos:` on the next `ado-aw compile`. See [Repositories (repos:)](/ado-aw/reference/front-matter/#repositories-repos) for the full syntax.
This example predates the current `repos:` shorthand and still uses the legacy `repositories:` + `checkout:` form shown above. Both are accepted — the legacy form is automatically rewritten to `repos:` the next time you run `ado-aw compile`. For new agents, prefer the compact `repos:` syntax:

```yaml
repos:
- my-org/my-repo
```

See [Repositories (repos:)](/ado-aw/reference/front-matter/#repositories-repos) for the full syntax.
:::

## ADO work item triage
Expand Down