Skip to content

Commit 7aad16a

Browse files
committed
docs: Shorten workflow and job names
1 parent 2964b4b commit 7aad16a

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ The a11y scanner helps teams:
1919
Create a workflow file in `.github/workflows/` (e.g., `a11y-scan.yml`) in your repository:
2020

2121
```YAML
22-
name: Continuous Accessibility Scanner
22+
name: Accessibility Scanner
2323
on: workflow_dispatch # This configures the workflow to run manually, instead of (e.g.) automatically in every PR. Check out https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#on for more options.
2424

2525
jobs:
26-
continuous_accessibility_scanner:
26+
accessibility_scanner:
2727
runs-on: ubuntu-latest
2828
steps:
2929
# Retrieve the scanner code
@@ -47,6 +47,7 @@ jobs:
4747
> 👉 Update all `REPLACE_THIS` placeholders with your actual values. See [Action Inputs](#action-inputs) for details.
4848

4949
Required Permissions:
50+
5051
- Write access to add or update workflows
5152
- Admin access to add repository secrets
5253

@@ -58,14 +59,16 @@ Required Permissions:
5859

5960
The a11y scanner requires two Personal Access Tokens (PATs) as repository secrets:
6061

61-
#### The `GH_COMMUNITY_PROJECTS_TOKEN` is a fine-grained PAT with:
62+
#### The `GH_COMMUNITY_PROJECTS_TOKEN` is a fine-grained PAT with
63+
6264
- `contents: read`
6365
- `metadata: read`
6466
- Scope: [`github-community-projects/continuous-ai-for-accessibility-scanner`](https://github.com/github-community-projects/continuous-ai-for-accessibility-scanner)
6567

66-
#### The `GH_TOKEN` is a fine-grained PAT with:
68+
#### The `GH_TOKEN` is a fine-grained PAT with
69+
6770
- `contents: write`
68-
- `issues: write`
71+
- `issues: write`
6972
- `pull-requests: write`
7073
- `metadata: read`
7174
- Scope: Your target repository (where issues and PRs will be created)

0 commit comments

Comments
 (0)