- See previous BP Docs-Chat Summary May 28, 2025
- In attendance: @dcavins (async), @narenin (async), @Muddassir Nasim (async), @@rollybueno (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.
Summary: There was only one real-time participant (@emaralive) for this meeting: meaning anyone who added a “reaction” or commented after the fact was included as an asynchronous attendee.
1️⃣ 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). The information covered was related the use of Docker as it pertained to the Slate Docs tool, e.g. “Using Slate in Docker”.
Due to a reduction in the number of writers/authors, the documentation effort has slowed to a crawl.
2️⃣ Continuation of the “revisit for the Update README with Documentation roadmap” – Part 8:
Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“
Update on the progress of the 1st feasibility study – Slate Docs
Using Slate in Docker – The Docker method proved to be outdated when pulling the “Slate Docs” image from the Docker Hub. It appears the dependency requirements were for Ruby 2.6 which was applicable at the time when Docker image and file known as “Dockerfile” were created and the same was apparently true for the Vagrant method. Updating “Dockerfile” to change the Ruby version from 2.6 to 3.3 along with updating “Gemfile” with the addition of 4 more Ruby gems and then using the “docker build” command created a Docker image that will now successfully build and serve the HTML documents.
All this means is that whichever method(s) is/are provided for building the BP REST API documents via the Slate tool, will have to be maintained to ensure a reliable build process, e.g., checked to make sure that there are no conflicts with dependencies as updates are made to those dependencies.
Phase 2 feasibility studies status
- 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”.
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.
3️⃣ Open Floor:
There were a couple of comments regarding an individual’s inability to attend this meeting in real-time, e.g. scheduling conflicts.
Next Docs-Chat
Our next documentation meeting will happen on June 25, 2025 at 19:00 UTC in #BuddyPress.
BP Team Updates 