Skip to content

Commit b4d605d

Browse files
Update README.md
1 parent 7a169f3 commit b4d605d

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,18 @@ poetry run jupyter-book build .
113113

114114
## Accessibility (optional, recommended)
115115

116-
The `accessibility.yml` workflow runs [Pa11y](https://pa11y.org/) to flag potential accessibility issues. You can disable it by removing the workflow or keep it to improve inclusivity.
116+
The `accessibility.yml` workflow runs [Pa11y](https://pa11y.org/) to flag potential accessibility issues. It builds the Jupyter Book, identifies changed pages, and posts an accessibility report as a PR comment.
117+
118+
### Setup
119+
120+
1. **Enable Actions and permissions**
121+
- Go to **Settings → Actions → General**.
122+
- Under **Actions permissions**, ensure actions are allowed.
123+
- Under **Workflow permissions**, set:
124+
- **Read and write permissions** ✅ (needed for posting PR comments and caching).
125+
- Keep **Require approval for first-time contributors** enabled (recommended).
126+
127+
✅ With this setup, Pa11y will automatically run on changed pages and provide feedback directly in your pull requests.
117128

118129
---
119130

0 commit comments

Comments
 (0)