Skip to content

Commit b5f76b5

Browse files
committed
fix: update quick-start guide to reflect daily team status workflow changes
1 parent b5d2eb6 commit b5f76b5

1 file changed

Lines changed: 47 additions & 16 deletions

File tree

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

Lines changed: 47 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ If this step fails, you may need to use a personal access token or run the [inst
2929
Add a sample from the [agentics](https://github.com/githubnext/agentics) collection. From your repository root run:
3030

3131
```bash wrap
32-
gh aw add githubnext/agentics/weekly-research --pr
32+
gh aw add githubnext/agentics/daily-team-status --pr
3333
```
3434

35-
This creates a pull request that adds `.github/workflows/weekly-research.md` and the compiled `.lock.yml`. Review and merge the PR into your repo.
35+
This creates a pull request that adds `.github/workflows/daily-team-status.md` and the compiled `.lock.yml`. Review and merge the PR into your repo.
3636

3737
### Step 3 — Add an AI secret
3838

@@ -65,7 +65,7 @@ For more information, see the [GitHub Copilot CLI documentation](https://github.
6565
Trigger the workflow immediately in GitHub Actions:
6666

6767
```bash wrap
68-
gh aw run weekly-research
68+
gh aw run daily-team-status
6969
```
7070

7171
After a few moments, check the status:
@@ -74,35 +74,66 @@ After a few moments, check the status:
7474
gh aw status
7575
```
7676

77-
Once complete, a new discussion post will be created in your repository with a research report! The report will be automatically generated by the AI based on recent developments in your field, and will be refreshed every week.
77+
Once complete, a new discussion post will be created in your repository with a daily news! The report will be automatically generated by the AI based on recent activity in your repository.
7878

7979
## Understanding Your First Workflow
8080

81-
Let's look at what you just added. The weekly research workflow automatically creates a research report every week and posts it as a discussion in your repository, and looks like this:
81+
Let's look at what you just added. The daily team status workflow automatically creates a status report every weekday and posts it as a discussion in your repository, and looks like this:
8282

8383
```aw wrap
8484
---
8585
on:
8686
schedule:
87-
- cron: "0 9 * * 1" # Every Monday at 9 AM
87+
- cron: "0 9 * * 1-5"
88+
workflow_dispatch:
89+
permissions:
90+
contents: read
91+
issues: read
92+
pull-requests: read
93+
network: defaults
94+
tools:
95+
github:
8896
safe-outputs:
89-
create-issue:
97+
create-discussion:
9098
---
9199

92-
# Weekly Research Report
100+
# Daily Team Status
93101

94-
Create a weekly research report summarizing recent developments in our field:
102+
Create an upbeat daily status report for the team as a GitHub discussion.
103+
- Recent repository activity (issues, PRs, discussions, releases, code changes)
104+
- Team productivity suggestions and improvement ideas
105+
- Community engagement highlights
106+
- Project investment and feature recommendations
95107

96-
1. Research recent developments and trends
97-
2. Summarize key findings
98-
3. Create an issue with the research report
99-
4. Tag relevant team members
108+
...
100109

101-
Keep the report concise but informative.
110+
1. Gather recent activity from the repository
111+
2. Create a new GitHub discussion with your findings and insights
102112
```
103113

104-
This workflow triggers every Monday at 9 AM via cron schedule, has permissions to read repository content and create GitHub issues, and runs AI instructions in natural language to generate research reports.
114+
This workflow triggers every weekday at 9 AM via cron schedule, has permissions to read repository content and create GitHub discussions, and runs AI instructions in natural language to generate status reports.
115+
116+
## Customize Your Workflow
117+
118+
Customize your workflow by editing the `.md` file and recompiling with `gh aw compile`.
119+
You can leverage the help of an agent to customize your workflow without having to learn about the YAML syntax. Run the following command to start an interactive session with GitHub Copilot CLI.
120+
121+
```bash wrap
122+
# install copilot cli
123+
npm install -g @github/copilot-cli
124+
# install the custom agent files
125+
gh aw init
126+
```
127+
128+
Then, run the following to create and edit your workflow:
129+
130+
```bash wrap
131+
# start an interactive session to customize the workflow
132+
copilot
133+
> /agent create-agentic-workflow
134+
> edit @.github/workflows/daily-team-status.md
135+
```
105136

106137
## What's next?
107138

108-
Customize your workflow by editing the `.md` file and recompiling with `gh aw compile`. Use [Authoring Agentic Workflows](/gh-aw/setup/agentic-authoring/) to create workflows with AI assistance, explore more samples in the [agentics](https://github.com/githubnext/agentics) repository, and learn about workflow management in [Packaging & Distribution](/gh-aw/guides/packaging-imports/). To understand how agentic workflows work, read [How It Works](/gh-aw/introduction/how-it-works/).
139+
Use [Authoring Agentic Workflows](/gh-aw/setup/agentic-authoring/) to create workflows with AI assistance, explore more samples in the [agentics](https://github.com/githubnext/agentics) repository, and learn about workflow management in [Packaging & Distribution](/gh-aw/guides/packaging-imports/). To understand how agentic workflows work, read [How It Works](/gh-aw/introduction/how-it-works/).

0 commit comments

Comments
 (0)