- See previous BP Docs-Chat Summary April 16, 2025
- In attendance: @dcavins, @narenin (async), @emaralive
- Slack Archive
- @emaralive will lead the next docs-chat meeting!
To Note: async (asynchronous) is a situation when an individual is not present during the meeting but, made an effort to make their presence known after the adjournment of the meeting. Additionally, user handles are taken from their respective Slack accounts and may not match up to WordPress.com accounts.
BP Documentation tracker status:
The stats – 58%, there was no change in percentage points – 58% ➡ 58%
NOTE: The stats remained flat due to no new issues were submitted and completions remained the same..
There is 1 (one) issue that is currently In Progress. For details see the In Progress section (Note: Project views are dynamic and are subject to change without notice).
Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.
The anomaly (truncated entries) with exporting view data while in Board layout was still present.
Continuation of the “revisit for the Update README with Documentation roadmap” – Part 5 :
Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“
- In progress:
- To Do:
- WordPress Playground documentation, based on Docusaurus – mentioned here
- WordPress Advanced Administration Handbook, based on WordPress – inferred here
- GitHub Wiki – mentioned during April 2, 2025 meeting.
- Completed:
- TBD
❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.
On deck (in progress), there was a preliminary look into the Slate Docs tool (API Docs Generator) and as it stands this tool is specifically geared towards the generation of API documentation which would be appropriate for the BP REST API. Some notable points regarding the Slate Docs tool were:
To reiterate, this tool is primarily for the generation of documentation specifically related to API (Application Programming Interface) – “Slate helps you create beautiful, intelligent, responsive API documentation.” Additionally, If this tool were to be used, it would only apply to the BP REST API documentation (V1 & V2) and most likely require a new repository to host the source documents due to how the tool is implemented. Currently the source documents/pages are located:
- V1 – developer.buddypress.org – as WP Handbook pages – conversion of pages to .md files can be found here
- V2 – BuddyPress REST API (v2) – as .md files
There was an attempt to highlight the need to pay attention to the Markdown syntax requirements since there is the appearance that each tool has different requirements.
❗ – in progress, ⭐ completed – toying with emojis to indicate basic status of any given study – no emoji indicates “to do”.
When time permits additional information will be placed within a bp-documentation discussion topic that will represent a feasibility study for the Slate Docs tool (API Docs Generator).
To provide context to this ongoing saga, there was information posted related to the backstory of how the documentation effort has progressed from inception to the current process for the creation of documentation, for example:
BP Documentation choices
- July 12, 2023: use BuddyPress code repository to reorganize/migrate/update/improve the BuddyPress Codex.
- January 10, 2024: create this repository to track BuddyPress Codex migration tasks as well as new documentation tasks.
- January 24, 2024: using GitHub to contribute on the next BuddyPress documentation is our choice & it’s a good one!
Note: This agenda item is slated to be on the agenda for the next documentation meeting as a continuance.
Open Floor:
Due to time constraints, there wasn’t time for Open Floor.
Next Docs-Chat
Our next documentation meeting will happen on May 14 2025, at 19:00 UTC in #BuddyPress.
BP Team Updates 