Report documentation problems like outdated content, typos, dead links, or missing information. Well-filed issues help the team prioritize fixes and update documentation faster.
- Reference: Reporting an issue workflow
- Connect: Join #docs on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/ and introduce yourself
Steps
- Search existing issues. Check the Documentation Issue Tracker to make sure your issue hasn’t been reported.
-
Open a new issue. using the appropriate template: Fix Doc Issue Report for problems with existing pages, or New Doc Request if you’d like to propose a new page.
-
Set a clear title. Begin with the documentation area, then concisely name the issue. Examples:
[HelpHub] Block Editor page missing keyboard shortcuts[DevHub] get_posts() examples outdated[Handbook] Typo in Issue Triage Process
- Add details. Fill in the issue template with all needed information, and any additional context that can help.
Contribution checklist
- Searched existing issues to avoid duplicates
- Used the correct issue template
- Title starts with documentation area
- Included all requested information
What happens next
A documentation team member will review your issue and either fix it or add it to the backlog. If you want to work on fixing issues yourself, try this guide: Work on Existing Documentation Issues.
Help
Stuck? Check the getting help guide, then ask in #docs.
Further reading:
– Documentation Issue Tracker handbook page
