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

BP Documentation tracker status:

The stats – 53%, which is an increase of 5 (five) percentage points – 48% ➡ 53%

BP REST API documentation:

We engaged in a preliminary discussion regarding V1 and V2 documentation with the highlights being:

• V1:
  • Archive the documentation, most likely within the BP-REST plugin GitHub repository.
  • Make corrections to references from bp.apiRequest to wp.apiRequest. (BP REST API Handbook)
  • Verify/validate whether there are bugs in the code or are there errors in the documentation, e.g., Replying to an existing Messages Thread – recipients array – a empty array appears to be required but the documentation does not stipulate a requirement, for such.
• V2:
  • The consensus was to place the V2 documentation where the other handbooks reside, in this case the developer handbook, in which a chapter seems to be appropriate.

In other words, V1 should be cleaned up prior to the creation of the V2 documentation. Additionally, @im4th granted limited administrative access to developer.buddypress.org (this where the V1 documentation currently resides) for @vapvarun and @emaralive.

And, lastly, there was recognition that a tool or tools could help facilitate the creation of documentation from in-line (code) docs and from web based docs/handbooks. The former (in-line) is unclear and the scope needs to be further defined, however, there is a tool that does a portion of this for “actions” and “filters”, as well as WordPress tools, e.g., WP Parser. For the later (web based docs), there is a tool that will convert WordPress (web based) documents into .md (GitHub flavored) markdown files, e.g,, potentially be able to archive the V1 documentation, although those with the requisite permissions could export the V1 documentation, which then becomes a partial process which requires additional processing to convert the export into markdown files.

Open Floor:

• There was a reminder given for the upcoming video chat regarding the “New BuddyPress Standalone Theme” (see New BuddyPress Standalone Theme – Upcoming Call for additional details).
• @im4th mentioned a documentation review was in process for PR 299 Template hierarchy that @vapvarun had authored.
• There was a brief discussion regarding future efforts for the authoring of additional documentation.

Next Docs-Chat

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

#docs-chat, #documentation, #summary