- See previous BP Docs-Chat Summary April 30, 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.
Summary: Due to @dcavins having to leave the meeting early, the meeting was adjourned after 30 minutes. There were 2 main points for the agenda regarding the 2nd item (Continuation of the “revisit for the Update README with Documentation roadmap” – Part 6):
- Finish up on any additional comments regarding the Slate tool, e.g., what info should be included in the feasibility study?
- Determine the next tool to be slated for a feasibility study
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 6:
Phase 2 – conduct feasibility studies for potential tools which should determine the “final web home“
Regarding “additional comments” for the feasibility study that is “in progress”, some points of interest conveyed were:
- The original Slate repo had been forked.
- Installation of some required software, e.g. Ruby, etc., will occur.
- Cloning of the forked repo locally will occur.
- Attempt to build and deploy locally – using Slate natively
As for “which tool should be up next for a feasibility study“, there was concurrence that the next tool as listed in the “To Do” section would be an adequate approach; meaning, the “Docusaurus” tool will be up next.
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.
Open Floor:
Due to a limiting factor of a 30 minute time constraint (as noted in the summary), there was only time for @dcavins to express his interest by stating:
I am interested to see how easily these various documentation software answers will work.
Next Docs-Chat
Our next documentation meeting will happen on May 28, 2025 at 19:00 UTC in #BuddyPress.