BuddyPress Statistics - Website Documentation
Growing a BuddyPress community without data means guessing about what is working. BuddyPress Statistics builds a detailed activity log tracking member counts, active users, status updates, groups, posts, and engagement trends.
This folder holds the customer and developer documentation for BuddyPress Statistics. The docs live in this GitHub repository only. They are not synced or published anywhere else.
Structure
Section titled “Structure”website/├── docs_config.json # Content manifest (categories, titles, slugs)├── getting-started/ # Introduction and installation├── global-settings/ # Admin tabs: Overview, Analytics views, Activity Log, Settings sub-tabs├── user-stats/ # Users tab and the member profile Statistics tab├── group-stats/ # Group Statistics tab├── widgets/ # Sidebar and Dashboard widgets├── developer-guide/ # Developer reference└── faq/ # FAQs and troubleshootingCategories
Section titled “Categories”| Folder | Category Name | Slug |
|---|---|---|
| getting-started | Getting Started | getting-started-bpstats |
| global-settings | Global Settings | global-settings-bpstats |
| user-stats | User Statistics | user-stats-bpstats |
| group-stats | Group Statistics | group-stats-bpstats |
| widgets | Widgets | widgets-bpstats |
| developer-guide | Developer Guide | developer-guide-bpstats |
| faq | FAQ | faq-bpstats |
Images
Section titled “Images”Images belong in images/ inside this folder, saved as .webp, and are referenced with relative paths from each doc (for example ../images/admin-overview.webp). Several docs list the screenshots they still need under a “Screenshots needed” heading.
Updating Docs
Section titled “Updating Docs”- Check every claim against the current plugin code and screens (labels, menu paths, defaults).
- Edit the markdown files in this folder.
- Update
docs_config.jsonwhen you add, rename, or remove a doc. - Commit the changes with the code change they describe.
Customer docs use plain language: no file paths, hook names, or function names. Those belong in developer-guide/.