Skip to content

Commit d502f1c

Browse files
committed
update docs
1 parent 2881b4d commit d502f1c

10 files changed

Lines changed: 40 additions & 17 deletions

docs/ci-doctor.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ This creates a pull request to add the workflow to your repository. After mergin
1818

1919
## Configuration
2020

21+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
22+
2123
1. Use local configuation to specify which workflows to monitor (currently monitors "Daily Perf Improver" and "Daily Test Improver"), investigation depth, failure categorization, and reporting format. Local configuration can be done in `.github/workflows/agentics/ci-doctor.config.md`.
2224

2325
2. Build tool configuration for build tools shared across all workflows installed from this pack can be done in `.github/workflows/agentics/build-tools.md`.

docs/daily-accessibility-review.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ gh aw run daily-accessibility-review
2222

2323
## Configuration
2424

25+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
26+
2527
1. Use local configuation to specify which accessibility standards to check (e.g., WCAG 2.1, WCAG 2.2), types of accessibility issues to prioritize, and reporting format. Local configuration can be done in `.github/workflows/agentics/daily-accessibility-review.config.md`.
2628

2729
2. Build tool configuration for build tools shared across all workflows installed from this pack can be done in `.github/workflows/agentics/build-tools.md`.

docs/daily-dependency-updates.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ gh aw run daily-dependency-updates
3232

3333
## Configuration
3434

35+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
36+
3537
1. Use local configuation to specify dependency management tools (npm, pip, maven, etc.), customize dependency update strategies and version constraints, onfigure which dependencies to include/exclude from automated updates. Local configuration can be done in `.github/workflows/agentics/daily-dependency-updates.config.md`.
3638

3739
2. Build tool configuration for build tools shared across all workflows installed from this pack can be done in `.github/workflows/agentics/build-tools.md`.

docs/daily-plan.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ gh aw run daily-plan
2222

2323
## Configuration
2424

25+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
26+
2527
1. Use local configuation to specify planning focus areas, reporting format, and frequency. Local configuration can be done in `.github/workflows/agentics/daily-plan.config.md`.
2628

2729
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.

docs/daily-qa.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ gh aw run daily-qa
2222

2323
## Configuration
2424

25-
3. Use local configuation to specify QA tasks, testing scenarios, reporting format, and frequency. Local configuration can be done in `.github/workflows/agentics/daily-qa.config.md`.
25+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
2626

27-
4. Build tool configuration for build tools shared across all workflows installed from this pack can be done in `.github/workflows/agentics/build-tools.md`.
27+
1. Use local configuation to specify QA tasks, testing scenarios, reporting format, and frequency. Local configuration can be done in `.github/workflows/agentics/daily-qa.config.md`.
28+
29+
2. Build tool configuration for build tools shared across all workflows installed from this pack can be done in `.github/workflows/agentics/build-tools.md`.
2830

2931
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
3032

docs/daily-team-status.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,9 +22,11 @@ gh aw run daily-team-status
2222

2323
## Configuration
2424

25-
- No build steps required - works out of the box
26-
- Edit the workflow file to customize status report format, metrics, modify report frequency or add specific team focuses
27-
- After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
25+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
26+
27+
1. Use local configuation to customize triage criteria, labeling logic, customize issue categorization, modify automated responses. Local configuration can be done in `.github/workflows/agentics/daily-team-status.config.md`.
28+
29+
2. Add MCPs to integrate with project management tools
2830

2931
## What it reads from GitHub
3032

docs/issue-triage.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,13 @@ This creates a pull request to add the workflow to your repository. You can't st
1818

1919
## Configuration
2020

21-
- No build steps required - works out of the box
22-
- Edit the workflow file to customize triage criteria, labeling logic, customize issue categorization, modify automated responses
23-
- Add MCPs to integrate with project management tools
24-
- After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
21+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
22+
23+
1. Use local configuation to customize triage criteria, labeling logic, customize issue categorization, modify automated responses. Local configuration can be done in `.github/workflows/agentics/issue-triage.config.md`.
24+
25+
2. Add MCPs to integrate with project management tools
26+
27+
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
2528

2629
## What it reads from GitHub
2730

docs/update-docs.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,13 @@ gh aw run update-docs
3333

3434
## Configuration
3535

36-
- Benefits from configuring build steps for documentation generation
37-
- Edit the workflow to specify your documentation framework (Astro Starlight, MkDocs, etc.)
38-
- Customize documentation structure, themes, and generation commands
39-
- Add project-specific documentation validation and deployment steps
40-
- Configure which files and directories to include in documentation updates
41-
- After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
36+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
37+
38+
1. Use local configuation to configure documentation frameworks, documentation structure, themes, files, directories. Local configuration can be done in `.github/workflows/agentics/update-docs.config.md`.
39+
40+
2. Build tool configuration for build tools shared across all workflows installed from this pack can be done in `.github/workflows/agentics/build-tools.md`.
41+
42+
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.
4243

4344
## What it reads from GitHub
4445

docs/weekly-research.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ gh aw run weekly-research
2222

2323
## Configuration
2424

25+
This workflow requires no configuration and works out of the box. However, you can customize it as follows:
26+
2527
1. Use local configuation to customize output format, research topics, report length, focus areas or to adjust frequency or timing. Local configuration can be done in `.github/workflows/agentics/daily-plan.config.md`.
2628

2729
After editing run `gh aw compile` to update the workflow and commit all changes to the default branch.

workflows/daily-accessibility-review.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,10 @@ on:
88

99
timeout_minutes: 15
1010

11-
safe-output:
12-
create-issue:
11+
12+
permissions:
13+
contents: read # Required so the agent can review the code in the repository
14+
issues: write # Required so the agent can create issues for accessibility problems
1315

1416
tools:
1517
playwright:
@@ -18,8 +20,11 @@ tools:
1820
command: npx
1921
args: ["@playwright/mcp@0.0.33", "--headless"]
2022
allowed: ["browser_click", "browser_evaluate", "browser_handle_dialog", "browser_hover", "browser_navigate", "browser_navigate_back", "browser_navigate_forward", "browser_press_key", "browser_resize", "browser_select_option", "browser_snapshot", "browser_take_screenshot", "browser_type", "browser_wait_for"]
23+
github:
24+
allowed: ["create_issue"]
2125
claude:
2226
allowed:
27+
TodoWrite:
2328
WebFetch:
2429
WebSearch:
2530

0 commit comments

Comments
 (0)