Hi @Shekhar0109 ,

Thanks for contributing to the BP documentation effort! The documentation team has neglected to provide a comprehensive description on how the documentation process should work and I'm not sure where the process description should reside, e.g.:

• In the Contributor handbook.
• A Wiki or GH pages within the bp-documentation repository.
• All of the above.

For now, I'll have to walk you through the process and I'll probably open a discussion in bp-documentation repo to start piecing together what will eventually be a comprehensive guide (description) of the documentation process.

Prior to reviewing your proposed changes, we should go over some housekeeping tasks, for example, the reference link should be to the Issue that resides in the bp-documentation repo and in order to accomplish this, the full URL will have be be posted: In this case it would be something similar to:

bp-documentation issue: https://github.com/buddypress/bp-documentation/issues/305

The above rendered would look like:

bp-documentation issue: buddypress/bp-documentation#305

Otherwise, GitHub will reference an Issue or PR from this repo (buddypress) which would be an incorrect reference link. Additionally, in the right hand sidebar the Labels area should be assigned to documentation and Projects should be assigned to Documentation, however, I don't remember if it takes an elevated privilege to change these settings, you will have to let me know whether or not you are able to make these changes in the sidebar area.

Next up is to go back to the referenced Issue in the bp-documentation repo and in the right hand sidebar, assign yourself to the Issue in the Assignees area and in the Projects area, change the Documentation status from Todo to In Progress and then finally in the Issue body under the Tasks to accomplish header, check/select the checkbox associated with the "A PR has been submitted to the BuddyPress GH repository, it has been linked to this issue/task & the task was moved to the "In progress" panel of the Documentation project." text. This reminds me that the text of this checkbox should change because this box should be checked when the Issue has been assigned; meaning the process was changed in an attempt to prevent the duplication of effort on the same Issue. I probably need to use more words and screenshots to depict the process flow, hence the need for documentation that describes the documentation process flow.

OK, that is pretty much the tasks to be completed prior to the review of the actual proposed changes. This explanation pretty much applies to the other 2 PRs you had submitted. Additionally, if something is still unclear, please don't hesitate to ask for clarification.

Hi @emaralive,

Thank you so much for explaining the process in detail 🙏. I really appreciate the guidance since I’m still getting familiar with the BuddyPress documentation workflow.

I’ll make sure to:

Reference the correct issues from the bp-documentation repo in my PRs.

Check and update labels, projects, and assignments as suggested (I’ll confirm if I have the required permissions; if not, I’ll let you know).

Assign myself to the related issues in bp-documentation and update the project status accordingly.

This helps me a lot in understanding how the documentation contribution flow should work. Please let me know if I miss anything, and I’m happy to adjust.

Thanks again for your support!

Sounds good and if anything gets missed, we will adjust accordingly. In the meantime, I created a discussion in the bp-documentation repo regarding the publication of the steps/tasks that I included in this PR, I mentioned you in the discussion but if you don't receive an email then you can follow and/or participate in the discussion, currently known as - Documentation that Describes the Process Flow for Contributors - Putting the Pieces Together, if you choose to do so (participation in the discussion is not required).