update docs more

- add scans input to top level action.yml

Author: abdulahmad307

.github/actions/find/action.yml

@@ -14,13 +14,13 @@ inputs:
     required: false
     default: 'false'
   scans:
-    description: 'Stringified JSON array of scans to perform. If not provided, only axe will be performed'
+    description: 'Stringified JSON array of scans to perform. If not provided, only Axe will be performed'
     required: false
   reduced_motion:
-    description: "Playwright reducedMotion setting: https://playwright.dev/docs/api/class-browser#browser-new-page-option-reduced-motion"
+    description: 'Playwright reducedMotion setting: https://playwright.dev/docs/api/class-browser#browser-new-page-option-reduced-motion'
     required: false
   color_scheme:
-    description: "Playwright colorScheme setting: https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme"
+    description: 'Playwright colorScheme setting: https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme'
     required: false
 
 outputs:

PLUGINS.md

@@ -2,24 +2,24 @@
 
 The plugin system allows teams to create custom scans/tests to run on their pages. An example of this is Axe interaction tests. In some cases, it might be desirable to perform specific interactions on elements of a given page before doing an Axe scan. These interactions are usually unique to each page that is scanned, so it would require the owning team to write a custom plugin that can interact with the page and run the Axe scan when ready. See the example under [.github/scanner-plugins/test-plugin](https://github.com/github/accessibility-scanner/tree/main/.github/scanner-plugins/test-plugin) (this is not an Axe interaction test, but should give a general understanding of plugin structure).
 
-Some plugins come built-in with the scanner and can be enabled via actions inputs.
+Some plugins come built-in with the scanner and can be enabled via [actions inputs](https://github.com/github/accessibility-scanner/tree/main/action.yml#L48-L50).
 
-## How Plugins Work
+## How plugins work
 
 Plugins are dynamically loaded by the scanner when it runs. The scanner will look into the `./.github` folder in your repo (where you run the workflow from) and search for a `scanner-plugins` folder. If it finds it, it will assume each folder under that is a plugin, and attempt to load the `index.js` file inside it. Once loaded, the scanner will invoke the exported default function from the `index.js` file.
 
 ### Default function API
 
 When the default function is invoked, the following arguments are passed to the function:
 
-- page: this is the [playwright page](https://playwright.dev/docs/api/class-page) instance. See the linked docs for information on how to interact with the page.
-- addFinding: this is a function that will add a finding to the list. Findings are used to generate issues and 'filings'. See here for the [types](https://github.com/github/accessibility-scanner/blob/main/tests/types.d.ts). This function expects a single object as an argument, and it should match the `Finding` type defined in the types linked above.
+- `page`: this is the [playwright page](https://playwright.dev/docs/api/class-page) instance.
+- `addFinding`: this is a function that will add a finding to the list. Findings are used to generate and file issues. This function expects a single object as an argument, and it should match the [`Finding` type](https://github.com/github/accessibility-scanner/blob/main/.github/actions/find/src/types.d.ts#L1-L9).
 
-## How To Create Plugins
+## How to create plugins
 
 As mentioned above, plugins need to exist under `./.github/scanner-plugins`. For a plugin to work, it needs to meet the following criteria:
 
-- Each seperate plugin should exist in a separate folder under `./.github/scanner-plugins`. So `./.github/scanner-plugins/plugin-1` would be 1 plugin loaded by the scanner.
+- Each separate plugin should be contained in it's own directory in `./.github/scanner-plugins`. For example, `./.github/scanner-plugins/plugin-1` would be 1 plugin loaded by the scanner.
 - Each plugin should have one `index.js` file inside its folder.
 - The `index.js` file must export a `name` field. This is the name used to pass to the `scans` input. So the following: `scans: ['my-custom-plugin']` would cause the scanner to only run that plugin.
 - The `index.js` file must export a default function. This is the function that the scanner uses to run the plugin. This can be an async function.

action.yml

@@ -1,58 +1,61 @@
-name: "accessibility-scanner"
-description: "Finds potential accessibility gaps, files GitHub issues to track them, and attempts to fix them with Copilot."
+name: 'accessibility-scanner'
+description: 'Finds potential accessibility gaps, files GitHub issues to track them, and attempts to fix them with Copilot.'
 
 inputs:
   urls:
-    description: "Newline-delimited list of URLs to check for accessibility issues"
+    description: 'Newline-delimited list of URLs to check for accessibility issues'
     required: true
     multiline: true
   repository:
-    description: "Repository (with owner) to file issues in"
+    description: 'Repository (with owner) to file issues in'
     required: true
   token:
     description: "Personal access token (PAT) with fine-grained permissions 'contents: write', 'issues: write', and 'pull_requests: write'"
     required: true
   cache_key:
-    description: "Key for caching results across runs"
+    description: 'Key for caching results across runs'
     required: true
   login_url:
-    description: "If scanned pages require authentication, the URL of the login page"
+    description: 'If scanned pages require authentication, the URL of the login page'
     required: false
   username:
-    description: "If scanned pages require authentication, the username to use for login"
+    description: 'If scanned pages require authentication, the username to use for login'
     required: false
   password:
-    description: "If scanned pages require authentication, the password to use for login"
+    description: 'If scanned pages require authentication, the password to use for login'
     required: false
   auth_context:
     description: "If scanned pages require authentication, a stringified JSON object containing 'username', 'password', 'cookies', and/or 'localStorage' from an authenticated session"
     required: false
   skip_copilot_assignment:
-    description: "Whether to skip assigning filed issues to Copilot"
+    description: 'Whether to skip assigning filed issues to Copilot'
     required: false
-    default: "false"
+    default: 'false'
   include_screenshots:
-    description: "Whether to capture screenshots and include links to them in the issue"
+    description: 'Whether to capture screenshots and include links to them in the issue'
     required: false
-    default: "false"
+    default: 'false'
   open_grouped_issues:
     description: "In the 'file' step, also open grouped issues which link to all issues with the same problem"
     required: false
-    default: "false"
+    default: 'false'
   reduced_motion:
-    description: "Playwright reducedMotion setting: https://playwright.dev/docs/api/class-browser#browser-new-page-option-reduced-motion"
+    description: 'Playwright reducedMotion setting: https://playwright.dev/docs/api/class-browser#browser-new-page-option-reduced-motion'
     required: false
   color_scheme:
-    description: "Playwright colorScheme setting: https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme"
+    description: 'Playwright colorScheme setting: https://playwright.dev/docs/api/class-browser#browser-new-context-option-color-scheme'
+    required: false
+  scans:
+    description: 'Stringified JSON array of scans to perform. If not provided, only Axe will be performed'
     required: false
 
 outputs:
   results:
-    description: "List of issues and pull requests filed (and their associated finding(s)), as stringified JSON"
+    description: 'List of issues and pull requests filed (and their associated finding(s)), as stringified JSON'
     value: ${{ steps.results.outputs.results }}
 
 runs:
-  using: "composite"
+  using: 'composite'
   steps:
     - name: Make sub-actions referenceable
       working-directory: ${{ github.action_path }}
@@ -163,5 +166,5 @@ runs:
         token: ${{ inputs.token }}
 
 branding:
-  icon: "compass"
-  color: "blue"
+  icon: 'compass'
+  color: 'blue'