Skip to content

Commit e3ce10a

Browse files
committed
Reorganizing:
- line wrapping - restore more specific link - move the caching question to directly follow the "what is the `gh-cache` branch for" question
1 parent f8ec0ba commit e3ce10a

File tree

1 file changed

+80
-32
lines changed

1 file changed

+80
-32
lines changed

FAQ.md

Lines changed: 80 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,84 +4,132 @@
44

55
### Do you support scanning PDFs?
66

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.
7+
Not at this time — our focus is on **website accessibility**, so PDF scanning
8+
isn't something we're planning to build into this Action.
89

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/).
10+
That said, there are great tools out there for that! We'd suggest checking out
11+
the [standalone PDF accessibility checkers listed by the PDF
12+
Association](https://pdfa.org/tools-for-accessible-pdf/).
1013

1114
### What about mobile apps, documents, or email templates?
1215

13-
This Action is built specifically to scan **websites, repositories, and dynamic content** for accessibility issues. We don't support scanning for:
16+
This Action is built specifically to scan **websites, repositories, and dynamic
17+
content** for accessibility issues. We don't support scanning for:
1418

1519
- **Mobile apps** (iOS or Android)
1620
- **Desktop applications**
1721
- **Documents** (Word, PowerPoint, Excel, etc.)
1822
- **Email templates**
1923

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.
24+
If you need accessibility testing for those, there are dedicated tools better
25+
suited for each — but for catching web accessibility problems before they reach
26+
your users, that's exactly what we're here for.
2127

2228
---
2329

2430
## Other / Repository-Wide Questions
2531

2632
### What's the `gh-cache` branch/Action all about?
2733

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.
34+
**The short version:** It's an orphan branch we use to store data between Action
35+
runs. You can safely ignore it — it's just a behind-the-scenes detail.
2936

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.
37+
**The longer version:** We use the `gh-cache` branch (and its associated Action)
38+
to keep track of issue data across runs. This is what prevents the Action from
39+
opening duplicate issues, and it's also how we're able to **automatically close
40+
issues** that have been fixed — in other words, if a problem isn't detected
41+
again on a subsequent run, we treat it as resolved.
3142

32-
Why a git branch instead of some other caching method? A couple of reasons:
43+
Why use a git branch instead of some other caching method? A couple of reasons:
3344

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.
45+
- You can view and edit the cache contents right in the GitHub UI — no extra
46+
tooling needed.
47+
- Everything is version-controlled, so you can manage it with the same git
48+
commands you already know.
49+
50+
### How do I remove or reset the cache?
51+
52+
Since the cache lives on the `gh-cache` branch, you have a couple of options:
53+
54+
- **Delete the branch entirely** — the Action will create a fresh one on its
55+
next run
56+
- **Edit or remove specific files** on the branch through the GitHub UI or git
57+
commands
58+
59+
Just keep in mind that resetting the cache means the Action will "forget" what
60+
it's already seen, so it may reopen issues that were previously tracked or
61+
closed.
3662

3763
### Does this work with private repositories?
3864

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.
65+
Yes! The Action works with both public and private repositories. Since it runs
66+
within GitHub Actions, it has access to your repository's content regardless of
67+
visibility settings. No extra configuration needed.
4068

4169
### Does this work with monorepos or multiple sites?
4270

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.
71+
It does. If your repository contains multiple sites or projects, you can
72+
configure separate workflow runs targeting different URLs or paths. Each scan
73+
runs independently, so you can tailor the setup to match however your repo is
74+
structured.
4475

4576
### How often does / should the Action run?
4677

4778
That's really up to you and your workflow. Some common setups include:
4879

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
80+
- **On every push or pull request** — great for catching issues early in
81+
development
82+
- **On a scheduled cron job** (e.g., daily or weekly) — good for ongoing
83+
monitoring of live sites
5184
- **Manually triggered** — useful for one-off audits
5285

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.
86+
If you're just getting started, running on pull requests is a solid default — it
87+
catches problems before they get merged without adding noise to every single
88+
commit.
5489

5590
### Will this slow down my CI/CD pipeline?
5691

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.
92+
The Action runs as its own job, so it won't block your builds or deployments
93+
unless you specifically configure it to. Scan times depend on the size and
94+
complexity of the site being scanned, but for most projects it adds minimal
95+
overhead. You can also run it on a schedule instead of on every push if speed is
96+
a concern.
5897

5998
### Can I customize which rules or checks are run?
6099

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.
100+
Under the hood, this Action uses
101+
**[axe-core](https://github.com/dequelabs/axe-core)** — the industry gold
102+
standard for automated accessibility testing. That gives you a solid,
103+
well-maintained foundation right out of the box.
62104

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.
105+
That said, you're not locked into a single setup. You can tap into different
106+
APIs and configure the Action to focus on the specific accessibility standards
107+
or rules that matter most to your project.
64108

65-
If you're looking to go even further, we also have resources for integrating accessibility into your development workflow with GitHub Copilot:
109+
If you're looking to go even further, we also have resources for integrating
110+
accessibility into your development workflow with GitHub Copilot:
66111

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
112+
- **[Getting Started with GitHub Copilot Custom Agents for
113+
Accessibility](https://accessibility.github.com/documentation/guide/getting-started-with-agents/)**
114+
— learn how to set up custom agents tailored to accessibility workflows
115+
- **[Optimizing GitHub Copilot for Accessibility with Custom
116+
Instructions](https://accessibility.github.com/documentation/guide/copilot-instructions/)**
117+
— fine-tune how Copilot assists you with accessibility-specific guidance
69118

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.
119+
Between axe-core's rule set, API flexibility, and Copilot's custom instructions,
120+
you've got a lot of room to shape the tooling around how your team actually
121+
works.
71122

72123
### Does this work with GitHub Enterprise?
73124

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.
125+
Yes, the Action is compatible with GitHub Enterprise Cloud. For GitHub
126+
Enterprise Server, compatibility may depend on your version and Actions
127+
availability. If you run into any issues, feel free to open an issue and we'll
128+
do our best to help.
84129

85130
### Can multiple people use this on the same repo?
86131

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.
132+
Absolutely. The Action is tied to the repository, not to any individual user.
133+
Anyone with the appropriate permissions can trigger runs, view results, and
134+
manage the issues it creates. It works just like any other GitHub Action in that
135+
regard.

0 commit comments

Comments
 (0)