Skip to content

Commit 839f18c

Browse files
authored
Update FAQ.md
Hi @JoyceZhu – I made some edits to your draft doc. Please review and update anything that doesn't make sense!
1 parent 476d2c8 commit 839f18c

File tree

1 file changed

+77
-21
lines changed

1 file changed

+77
-21
lines changed

FAQ.md

Lines changed: 77 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,87 @@
1-
# [Frequently-Asked Questions (FAQ)]
1+
# FAQ
22

3-
## `find` Action (Scanning for problems)
3+
## Find Action (Scanning for Problems)
44

55
### Do you support scanning PDFs?
66

7-
We're focusing this Action on website accessibility and currently don't plan to
8-
add PDF scanning capabilities.
7+
Not at this time — our focus is on **website accessibility**, so PDF scanning isn't something we're planning to build into this Action.
98

10-
If you're looking to scan PDFs, we recommend using one of the
11-
[standalone PDF accessibility checkers listed by the PDF
12-
Association](https://pdfa.org/tools-for-accessible-pdf/).
9+
That said, there are great tools out there for that! We'd suggest checking out the standalone PDF accessibility checkers listed by the [PDF Association](https://www.pdfa.org/).
1310

14-
## Other / repository-wide questions
11+
### What about mobile apps, documents, or email templates?
1512

16-
### What is the `gh-cache` branch/Action for?
13+
This Action is built specifically to scan **websites, repositories, and dynamic content** for accessibility issues. We don't support scanning for:
1714

18-
Short answer: This is an orphan branch for storing information between Actions
19-
runs. It's an implementation detail and can be safely ignored by users.
15+
- **Mobile apps** (iOS or Android)
16+
- **Desktop applications**
17+
- **Documents** (Word, PowerPoint, Excel, etc.)
18+
- **Email templates**
2019

21-
Longer answer: We use the `gh-cache` branch and [its associated
22-
Action](https://github.com/github/accessibility-scanner/tree/066e45c819d270bfb2392cfe141b570131c8011b/.github/actions/gh-cache)
23-
to persist issue data between action runs, which both prevents opening duplicate
24-
issues and allows us to automatically close issues which have been fixed
25-
(in other words, if a problem wasn't detected again in an ensuing run, it is
26-
therefore no longer a problem).
20+
If you need accessibility testing for those, there are dedicated tools better suited for each — but for catching web accessibility problems before they reach your users, that's exactly what we're here for.
2721

28-
Using a `git` branch as a caching mechanism allows users to view and/or edit the current
29-
contents of the cache through the usual GitHub user interface. It also means the
30-
contents of the cache are version controlled and can be changed through the
31-
`git` commands users are accustomed to.
22+
---
23+
24+
## Other / Repository-Wide Questions
25+
26+
### What's the `gh-cache` branch/Action all about?
27+
28+
**The short version:** It's an orphan branch we use to store data between Action runs. You can safely ignore it — it's just a behind-the-scenes detail.
29+
30+
**The longer version:** We use the `gh-cache` branch (and its associated Action) to keep track of issue data across runs. This is what prevents the Action from opening duplicate issues, and it's also how we're able to **automatically close issues** that have been fixed — if a problem isn't detected again on a subsequent run, we treat it as resolved.
31+
32+
Why a git branch instead of some other caching method? A couple of reasons:
33+
34+
- You can view and edit the cache contents right in the GitHub UI — no extra tooling needed.
35+
- Everything is version-controlled, so you can manage it with the same git commands you already know.
36+
37+
### Does this work with private repositories?
38+
39+
Yes! The Action works with both public and private repositories. Since it runs within GitHub Actions, it has access to your repository's content regardless of visibility settings. No extra configuration needed.
40+
41+
### Does this work with monorepos or multiple sites?
42+
43+
It does. If your repository contains multiple sites or projects, you can configure separate workflow runs targeting different URLs or paths. Each scan runs independently, so you can tailor the setup to match however your repo is structured.
44+
45+
### How often does / should the Action run?
46+
47+
That's really up to you and your workflow. Some common setups include:
48+
49+
- **On every push or pull request** — great for catching issues early in development
50+
- **On a scheduled cron job** (e.g., daily or weekly) — good for ongoing monitoring of live sites
51+
- **Manually triggered** — useful for one-off audits
52+
53+
If you're just getting started, running on pull requests is a solid default — it catches problems before they get merged without adding noise to every single commit.
54+
55+
### Will this slow down my CI/CD pipeline?
56+
57+
The Action runs as its own job, so it won't block your builds or deployments unless you specifically configure it to. Scan times depend on the size and complexity of the site being scanned, but for most projects it adds minimal overhead. You can also run it on a schedule instead of on every push if speed is a concern.
58+
59+
### Can I customize which rules or checks are run?
60+
61+
Under the hood, this Action uses **[axe-core](https://github.com/dequelabs/axe-core)** — the industry gold standard for automated accessibility testing. That gives you a solid, well-maintained foundation right out of the box.
62+
63+
That said, you're not locked into a single setup. You can tap into different APIs and configure the Action to focus on the specific accessibility standards or rules that matter most to your project.
64+
65+
If you're looking to go even further, we also have resources for integrating accessibility into your development workflow with GitHub Copilot:
66+
67+
- **[Getting Started with GitHub Copilot Custom Agents for Accessibility](https://accessibility.github.com/documentation/guide/getting-started-with-agents/)** — learn how to set up custom agents tailored to accessibility workflows
68+
- **[Optimizing GitHub Copilot for Accessibility with Custom Instructions](https://accessibility.github.com/documentation/guide/copilot-instructions/)** — fine-tune how Copilot assists you with accessibility-specific guidance
69+
70+
Between axe-core's rule set, API flexibility, and Copilot's custom instructions, you've got a lot of room to shape the tooling around how your team actually works.
71+
72+
### Does this work with GitHub Enterprise?
73+
74+
Yes, the Action is compatible with GitHub Enterprise Cloud. For GitHub Enterprise Server, compatibility may depend on your version and Actions availability. If you run into any issues, feel free to open an issue and we'll do our best to help.
75+
76+
### How do I remove or reset the cache?
77+
78+
Since the cache lives on the `gh-cache` branch, you have a couple of options:
79+
80+
- **Delete the branch entirely** — the Action will create a fresh one on its next run
81+
- **Edit or remove specific files** on the branch through the GitHub UI or git commands
82+
83+
Just keep in mind that resetting the cache means the Action will "forget" what it's already seen, so it may reopen issues that were previously tracked or closed.
84+
85+
### Can multiple people use this on the same repo?
86+
87+
Absolutely. The Action is tied to the repository, not to any individual user. Anyone with the appropriate permissions can trigger runs, view results, and manage the issues it creates. It works just like any other GitHub Action in that regard.

0 commit comments

Comments
 (0)