BP Documentation tracker stats
- BP Codex contains 271 pages.
- 202 total tasks were created (migrate + ignore + add + update).
- 194 tasks related to pages reviewed were created (migrate + ignore).
- 42 « migrate » tasks were created.
- 152 « ignore » tasks were created.
- 5 « add » tasks were created.
- 3 « update » tasks were created.
- Approximately, 72% of a total of 271 pages have been reviewed (194 / 271)
There were various comments by @dcavins & @im4th in regard to the stats:
- @dcavins made note of the number of ignore tasks that were created and asked whether this was a indication of out of date documents.
- @im4th made note of the progress made and responded to @dcavins regarding out of date documents, e.g,, pre 1.7 information, Theme changelog, snippets of code, etc.
- @vapvarun & @dcavins conversed a little bit about the efficacy of code snippets.
Review of how WP Docs teams handle discrepancies with published documentation (2 examples)
Example 1 (one) was a DevHub (Advanced Adminstration Handbook) document and example 2 (two) was a HelpHub (End User – Support Guides ) document, of which the purpose was to plant the seed as to how the BP Team would/should handle user feedback:
- DevHub provided a link to GitHub Advanced Admintration repository.
- HelpHub provided a comment box, in which to provide user feedback.
@im4th made note of some confusion regarding the use of discrepancies (the meaning thereof), of which @emaralive provided a general meaning and @dcavins expanded the meaning to include suggestions for improvement. @im4th was initially of the thought to use a method similar to how DevHub handled the situation and wanted a concrete example. @emaralive mentioned that example 2 was an actual issue (the text and screenshots are out of date, from WP v4.9.6, approx.). To move things along and not to belabor the point of this exercise, @emaralive mentioned the opening of a Discussion topic within the document tracking respository whereby further dialogue could be advanced, n,b,, @emaralive still needs to open the topic.
Open Floor
Earlier @vapvarun mentioned he had some documentation related Pull Requests ready to go. During Open Floor @vapvarun indicated the following would be next up for him:
- Configure BuddyPress for Multisite ( possible cases )
- Installation in WordPress Multisite
- Languages and Translations
@im4th indicated the he would review the Pull Requests that @vapvarun had ready to go. During this Open Floor time, @espellcaste indicated that he had documentation (.md files) related to BP CLI that could be placed within the BP docs folder, however, @im4th had some reservations as to where the BP CLI documents should reside. Additiionally, @espellcaste indicated that he had plans to outline the workflow related to BP CLI documents and since we were short on time, I indicated that I would open a Discussion topic in the BP document tracking repository, of which, that discussion can be found here.
Next Docs-Chat
It will happen on March 13, 2024 at 19:00 UTC in #BuddyPress.
#docs-chat, #documentation, #summary