Skip to content

Conversation

@cehfisher
Copy link
Contributor

This PR updates the README, CONTRIBUTING, and SUPPORT documentation to improve clarity and consistency. Key changes include: adding emojis and visual improvements throughout the README, reorganizing "Learn more" links to remove duplicates and improve logical flow, updating the Requirements section to clarify what's needed (including that GitHub Copilot is optional), converting all headings to sentence case, ensuring consistent terminology ("a11y scanner"/"accessibility scanner" and "GitHub Copilot"), and updating CONTRIBUTING and SUPPORT files to clarify that we're not accepting PRs at this time but welcome testing, feedback, and issue creation. The documentation now provides a clearer path for users to get started while setting appropriate expectations about contributions and feature requests.

Updated references from 'Copilot' to 'GitHub Copilot' and improved clarity in the README.
Updated the contributing guidelines to clarify contribution process and provide detailed instructions for creating issues and feature requests.
Updated support documentation to clarify issue filing and project maintenance status.
@cehfisher cehfisher requested a review from a team as a code owner October 23, 2025 18:21
@cehfisher cehfisher enabled auto-merge October 23, 2025 18:21
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR standardizes documentation formatting and improves clarity across the project's core documentation files. The updates convert all headings to sentence case, ensure consistent terminology usage (particularly for "GitHub Copilot" and "a11y scanner"), and add visual enhancements like emojis throughout the README.

Key changes:

  • Clarified that the project is in public preview (not beta) and that GitHub Copilot is optional
  • Reorganized "Learn more" sections to improve logical flow and remove duplicate links
  • Updated contribution guidelines to explicitly state that PRs are not being accepted, while encouraging testing, feedback, and issue creation

Reviewed Changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
README.md Updated project description, requirements section, added emojis, reorganized learning resources, and standardized terminology and heading case
SUPPORT.md Converted headings to sentence case, clarified project status as public preview, and updated terminology for consistency
CONTRIBUTING.md Changed heading level, expanded contribution guidelines to clarify that PRs aren't accepted but issues and feedback are welcome

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants