Skip to content

Commit caa21a5

Browse files
Copilotgh-aw-botpelikhan
authored
docs(quick-start): clarify githubnext/agentics origin and simplify .lock.yml paragraph (#38189)
* Initial plan * docs: improve Quick Start clarity for githubnext/agentics and lock.yml Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com> Co-authored-by: Peli de Halleux <pelikhan@users.noreply.github.com>
1 parent d1c293e commit caa21a5

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

docs/src/content/docs/setup/quick-start.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ From your repository root run:
6262
gh aw add-wizard githubnext/agentics/daily-repo-status
6363
```
6464
65-
`add-wizard` accepts workflow references in `<owner>/<repo>/<workflow-name>` format. In this example, `githubnext/agentics/daily-repo-status` points to the `daily-repo-status.md` workflow in the `githubnext/agentics` repository.
65+
`add-wizard` accepts workflow references in `<owner>/<repo>/<workflow-name>` format. In this example, `githubnext/agentics/daily-repo-status` references the `daily-repo-status` workflow hosted in the public [githubnext/agentics](https://github.com/githubnext/agentics) examples repository.
6666

6767
This will take you through an interactive process to:
6868

@@ -72,7 +72,7 @@ This will take you through an interactive process to:
7272
4. **Add the workflow** - Adds the workflow file (`.md`) and its generated GitHub Actions lock file (`.lock.yml`) to `.github/workflows/`.
7373
5. **Optionally trigger an initial run** - Starts the workflow immediately.
7474

75-
The `.lock.yml` file is the compiled GitHub Actions workflow generated from the `.md` source file. Keep editing the `.md` file; the lock file exists so GitHub Actions has a deterministic, runnable workflow definition. Do not edit `.lock.yml` directlyregenerate it with `gh aw compile` after making workflow changes. See [Lock File Header](/gh-aw/reference/workflow-structure/#lock-file-header).
75+
The wizard generates a compiled workflow file (`.lock.yml`) automaticallyyou don't need to edit it. See [Lock File](/gh-aw/reference/workflow-structure/#lock-file-header) for the full explanation.
7676

7777
> [!NOTE]
7878
> **Setting up `COPILOT_GITHUB_TOKEN`?**

0 commit comments

Comments
 (0)