You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+4-8Lines changed: 4 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ The a11y scanner helps teams:
8
8
- 📝 Create actionable GitHub issues that can be assigned to Copilot
9
9
- 🤖 Propose fixes with Copilot, with humans reviewing before merging
10
10
11
-
> ⚠️ The a11y scanner is currently in beta. It can help identify accessibility gaps but cannot guarantee fully accessible code suggestions. Always review before merging.
11
+
> ⚠️ **Note:**The a11y scanner is currently in beta. It can help identify accessibility gaps but cannot guarantee fully accessible code suggestions. Always review before merging!
12
12
13
13
---
14
14
@@ -44,7 +44,7 @@ jobs:
44
44
token: ${{ secrets.GH_TOKEN }} # This token must have write access to the repo above (contents, issues, and PRs); more information below. Note: GitHub Actions’ `GITHUB_TOKEN` (https://docs.github.com/en/actions/tutorials/authenticate-with-github_token) cannot be used here.
45
45
```
46
46
47
-
> Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for more details.
47
+
> 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details.
48
48
49
49
Required Permissions:
50
50
- Write access to add or update workflows
@@ -70,19 +70,15 @@ The a11y scanner requires two Personal Access Tokens (PATs) as repository secret
70
70
- `metadata: read`
71
71
- Scope: Your target repository (where issues and PRs will be created)
72
72
73
-
> GitHub Actions' default `GITHUB_TOKEN` cannot be used here.
73
+
> 👉 GitHub Actions' default `GITHUB_TOKEN` cannot be used here.
74
74
75
75
📚 [Creating a fine-grained PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) | [Creating repository secrets](https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/use-secrets#creating-secrets-for-a-repository)
76
76
77
77
---
78
78
79
79
### 3. Run Your First Scan
80
80
81
-
Trigger the workflow, either manually or automatically based on your configuration. The a11y scanner will:
82
-
83
-
- 🔎 Analyze your target URLs, files, or repos
84
-
- 📝 File issues for accessibility findings
85
-
- 🤖 Optionally assign issues to Copilot to create PRs with proposed fixes
81
+
Trigger the workflow manually or automatically based on your configuration. The scanner will run and create issues for any accessibility findings. When issues are assigned to Copilot, always review proposed fixes before merging.
86
82
87
83
📚 [Running a workflow manually](https://docs.github.com/en/actions/how-tos/manage-workflow-runs/manually-run-a-workflow#running-a-workflow)
0 commit comments