Skip to content

Commit 476d2c8

Browse files
committed
Add more documentation for the following:
- what the `gh-cache` branch is for - PDF scanning is outside our scope
1 parent 066e45c commit 476d2c8

2 files changed

Lines changed: 36 additions & 3 deletions

File tree

FAQ.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# [Frequently-Asked Questions (FAQ)]
2+
3+
## `find` Action (Scanning for problems)
4+
5+
### Do you support scanning PDFs?
6+
7+
We're focusing this Action on website accessibility and currently don't plan to
8+
add PDF scanning capabilities.
9+
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/).
13+
14+
## Other / repository-wide questions
15+
16+
### What is the `gh-cache` branch/Action for?
17+
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.
20+
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).
27+
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.

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The AI-powered Accessibility Scanner (a11y scanner) is a GitHub Action that dete
44

55
The a11y scanner helps teams:
66

7-
- 🔍 Scan websites, files, repositories, and dynamic content for accessibility issues
7+
- 🔍 Scan websites, repositories, and dynamic content for accessibility issues
88
- 📝 Create actionable GitHub issues that can be assigned to GitHub Copilot
99
- 🤖 Propose fixes with GitHub Copilot, with humans reviewing before merging
1010

@@ -14,6 +14,8 @@ The a11y scanner helps teams:
1414

1515
---
1616

17+
## [Frequently-Asked Questions (FAQ)](FAQ.md)
18+
1719
## Requirements
1820

1921
To use the a11y scanner, you'll need:
@@ -148,11 +150,11 @@ The a11y scanner leverages GitHub Copilot coding agent, which can be configured
148150

149151
💬 We welcome your feedback! To submit feedback or report issues, please create an issue in this repository. For more information on contributing, please refer to the [CONTRIBUTING](./CONTRIBUTING.md) file.
150152

151-
## License
153+
## License
152154

153155
📄 This project is licensed under the terms of the MIT open source license. Please refer to the [LICENSE](./LICENSE) file for the full terms.
154156

155-
## Maintainers
157+
## Maintainers
156158

157159
🔧 Please refer to the [CODEOWNERS](./.github/CODEOWNERS) file for more information.
158160

0 commit comments

Comments
 (0)