BP Documentation tracker stats
If you missed January 10 docs chat, We decided to create a new GitHub repository: bp-documentation, to use issues as Documentation tasks and to regularly update a GitHub project to track our progress.
- BP Codex contains 271 pages.
- 127 pages were reviewed so far.
- 40 « migrate » tasks were created.
- 87 « ignore » tasks were created.
- 144 BP Codex pages still need a review.
Reasons to ignore a BP Codex page:
- Codex page content is deprecated/outdated.
- Codex page content is a user generated guide containing code snippets.
@im4th thinks checking every code snippets is still accurate would take us too much time. The ignored content is not lost as it will remain into the BP Codex for history.
We think we’ll probably need to include an Advanced Users chapter to the User Handbook.
Contributing to docs is improving code!
@im4th has found bugs with our Site Health debug panel while working on documenting it. He’ll soon open a Trac ticket about it.
@emaralive found another one with Profile photos when the image file contains « -bpfull »or « -bpthumb » within its name.
@vapvarun suggested to create new documentation links closer to WP Admin sections using an information dashicon for instance, these links would direct the user to the specific anchor of the generated Markdown file view on GitHub.
And..
An help tab containing a link to the documentation page on each BP Admin screen
@emaralive started this discussion about it & @im4th thinks we should always have an help tab with a documentation link for any BP Admin screens we’re adding to the WP Dashboard.
Open floor
- We’ve decided to move the docs chat to every other Wednesdays that are a week after dev-chats. We’re starting next week on February 14 at 19:00 UTC. We haven’t changed the hour when we meet as 19:00 UTC is already very late for @vapvarun (he can’t currently contribute to dev-chats as it’s happening at 3 AM his time: we’ll need to discuss about it with other members of the team).
- Take turns leading the documentation meetings: @vapvarun will lead next one, @emaralive the one after, etc… @im4th thinks it can be interesting to do so as he might miss or do not stress enough some points others would have. Here are roughly tasks a leader should achieve:
- Prepare the docs-chat agenda & publish it on this site.
- Run the chat in #BuddyPress.
- Write the chat summary on this site.
Next Docs-Chat
It will happen on February 14, 2024 at 19:00 UTC in #BuddyPress.
⏳♻️
#docs-chat, #documentation, #summary