Add more documentation for the following:#146
Conversation
- what the `gh-cache` branch is for - PDF scanning is outside our scope
There was a problem hiding this comment.
Pull request overview
This PR adds documentation clarifying two frequently asked questions: that PDF scanning is outside the scope of this action, and explaining the purpose of the gh-cache branch. It also removes "files" from the list of scanning capabilities since the action only supports scanning websites and repositories via URLs.
Changes:
- Created a new FAQ.md file documenting PDF scanning limitations and the gh-cache branch purpose
- Updated README.md to reference the new FAQ and corrected the scanning capabilities description
- Removed trailing whitespace from section headings in README.md
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| FAQ.md | New file documenting frequently asked questions about PDF scanning support and the gh-cache branch implementation |
| README.md | Added FAQ link, removed "files" from scanning capabilities list, and cleaned up trailing whitespace in headings |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
FAQ.md
Outdated
| @@ -0,0 +1,31 @@ | |||
| # [Frequently-Asked Questions (FAQ)] | |||
There was a problem hiding this comment.
The heading has unnecessary square brackets. This is not standard Markdown syntax. The brackets should be removed:
Change from: # [Frequently-Asked Questions (FAQ)]
To: # Frequently-Asked Questions (FAQ)
This follows the standard markdown heading convention seen in other documentation files in this repository (e.g., CONTRIBUTING.md uses # Contributing, SECURITY.md uses # Security, SUPPORT.md uses # Support).
| # [Frequently-Asked Questions (FAQ)] | |
| # Frequently-Asked Questions (FAQ) |
FAQ.md
Outdated
| runs. It's an implementation detail and can be safely ignored by users. | ||
|
|
||
| Longer answer: We use the `gh-cache` branch and [its associated | ||
| Action](https://github.com/github/accessibility-scanner/tree/066e45c819d270bfb2392cfe141b570131c8011b/.github/actions/gh-cache) |
There was a problem hiding this comment.
The link uses a hardcoded commit SHA (066e45c) which will become outdated as the code evolves. Consider using a stable branch reference instead, such as:
https://github.com/github/accessibility-scanner/tree/main/.github/actions/gh-cache
This will ensure users always see the current version of the gh-cache Action documentation.
| Action](https://github.com/github/accessibility-scanner/tree/066e45c819d270bfb2392cfe141b570131c8011b/.github/actions/gh-cache) | |
| Action](https://github.com/github/accessibility-scanner/tree/main/.github/actions/gh-cache) |
Hi @JoyceZhu – I made some edits to your draft doc. Please review and update anything that doesn't make sense!
Added a section explaining how feature requests are prioritized.
- line wrapping - restore more specific link - move the caching question to directly follow the "what is the `gh-cache` branch for" question
Co-authored-by: Helen Hou-Sandi <helen@github.com>
gh-cachebranch is for