[Walkthrough] File a Documentation Issue

[supernovia]

Please walk through this guide and file a pathway feedback issue.

File a Documentation Issue

[marutim]

Slack discussion in docs about the walkthrough review: https://wordpress.slack.com/archives/C02RP4WU5/p1779360447513049

[marutim]

Filed my first report: WordPress/Documentation-Issue-Tracker#2302

One point of confusion is under the Steps section, specifically step 3: “Assign yourself by commenting /assign.”

Steps 1 and 2 are clear: first, search for an existing issue, then open a new issue using the appropriate template. However, step 3 could use clarification. Since this pathway appears to focus on filing documentation issues, it is not fully clear whether the person filing the issue is expected to assign themselves and work on the fix, or whether the issue should be picked up later by a contributor with documentation edit access.

Could we clarify step 3 to say something like:

If you have access to edit the documentation and would like to work on the issue yourself, assign it to yourself by commenting /assign.

This would help avoid confusion for new contributors who may only be reporting the issue, not fixing it themselves.

cc: @chekle

[chekle]

Thanks for your review, @marutim!

I've updated the steps and added a 5th based on your feedback:

3. Ask to be assigned to the issue. If you'd like to work on the issue yourself, comment /assign on the issue. If that doesn't work, leave a comment and a team member will assign you.

4. Post your findings or proposed fix as a comment on the issue. Submit for review by commenting /review on the issue to move it to the [Status] Review label automatically.

5. Apply the update to the documentation. Once the review is complete, apply the update to the documentation page if you have edit access. If you don't, a team member with permissions will take it from there.

Let me know what you think!