• See previous BP Docs-Chat Summary October 16, 2024
• In attendance: @im4th @emaralive
• Slack Archive
• @emaralive will lead the next docs-chat meeting!

As happenstance would have it, this docs-chat meeting occurred without an agenda, without a designated lead/facilitator and commenced 30 minutes late. What follows is what transpired during the remaining 30 minutes.

BP Documentation tracker status:

The stats – 59%, which is an increase of 1 (one) percentage point – 58% ➡ 59%

NOTE: There are 2 issues that are currently “In Progress“. For details see the “In Progress” section (Note: Project views are dynamic and are subject to change without notice).

Open Floor:

BP REST API V2 Documentation:

During this conversation, @im4th indicated that his strategy for the v2 (version 2) documentation was to complete the main endpoint routes before moving on the the others.

• At the time of this summary, there are 7 (seven) documents that have been completed:
  • Introduction
  • Activity REST API routes
  • Components REST API routes
  • User Groups REST API routes
  • Members REST API routes
  • Private Messaging REST API routes
  • BP REST API Reference

BuddyPress Constants Documentation:

During this conversation, @emaralive indicated there is some slowness in gathering information that will be used to describe each Constant due to interpreting what the coding reveals and what valid values can be used when defining the various Constants.

The BP_DEFAULT_COMPONENT was used as an example, as this Constant has multiple valid values that can be defined, however, previous documentation and comments in the code only provide information regarding when this Constant is “undefined” or when the value is defined as “profile“. In short, when defined, invalid values can cause unexpected behavior thus, it is important to list the valid values.

Additionally, the BP_DISABLE_AUTO_GROUP_JOIN Constant is slated to become deprecated when Trac ticket #9249 is implemented. This will require changes to the constants.md file (currently a rough draft) and code related to the Site Health Info page/screen – BuddyPress Constants panel.

Further conversation led to when the BP_ENABLE_MULTIBLOG Constant would be deprecated since earlier in the year there was mention of such an occurrence, of which @im4th indicated that, perhaps, after several future major releases had occurred. The conversation segued into the buddypress.org domain since the WordPress Meta Environment (deprecated) contained use of the BP_ENABLE_MULTIBLOG Constant which then further segued into various past and present subdomains of buddypress.org, just to name a few:

• fr.buddypress.org – (French) – available, but no longer maintained
• es.buddypress.org (Spanish) – no longer available
• nl.buddypress.org (Dutch) – no longer available

Lastly, @im4th mentioned that he was improving BP (BuddyPress) to “play nicer” with WP (WordPress) Playground and had also noticed that WP Playground team was making use of GH (GitHub) pages for its documentation which was built with Docusorus.

Next Docs-Chat

Our next documentation meeting will happen on November 13, 2024, at 19:00 UTC in #BuddyPress.

#docs-chat, #documentation, #summary