Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
The current README provides good high-level instructions for contributing to GitHub Docs.
It would be helpful to add a dedicated section or link specifically about how to run a local preview of documentation changes to assist new contributors in testing their edits.
Consider adding troubleshooting tips for common issues encountered during setup or when opening a Codespace.
Possibly add more accessibility notes about images and links.
What part(s) of the article would you like to see updated?
Wording improvements:
Suggest changing the sentence “That’s how you can easily become a member of the GitHub Docs community.”
to something more inclusive and professional like:
“That’s how you can become a valued member of the GitHub Docs community.”
Clarify account support link:
The sentence “If you're having trouble with your GitHub account, contact Support.” could be confusing.
Consider clarifying that this is general GitHub account support, not docs-specific support.
Add a brief local preview guide:
For new contributors, it would be helpful to add a short line or link explaining how to preview changes locally (especially if contributing to content/ files).
This would make the onboarding process smoother for first-time contributors who want to validate their edits.
Accessibility suggestion (optional):
Confirm that all images include meaningful alt text for screen readers (currently seems okay, but worth mentioning).
Why should the docs be changed? What use cases does it support?
These small improvements would:
Enhance readability and inclusivity.
Reduce confusion for new contributors (especially around support links).
Help contributors preview changes before submitting PRs.
Support accessibility best practices.
Additional information
No response