Skip to content

Commit 530a532

Browse files
Tsvetan StoychevTsvetan Stoychev
authored andcommitted
Improve WordPress.org listing and screenshots
1 parent 7b95b30 commit 530a532

10 files changed

Lines changed: 91 additions & 84 deletions

File tree

‎docs/audits/checklist.md‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,16 @@ operator-journey defect, P3 = minor/polish.
119119
backoffice with a time expectation) and "No data is arriving" checklist
120120
(admin tracking off, consent mode with no adapter, wrong CookieYes
121121
category, stale caches). (UX 3 / BR-DOC-08, BR-DOC-09, walkthrough-06)
122-
- [ ] P2 Lifecycle docs: purge caches after disabling/deactivating (cached
122+
- [x] P2 Lifecycle docs: purge caches after disabling/deactivating (cached
123123
pages keep the loader; browser-cached HTML cannot be purged at all);
124124
what deactivation keeps vs uninstall removes; multisite
125125
guidance. (UX 8 / BR-DOC-13, BR-DOC-17, BR-DOC-18, BR-DOC-20)
126-
- [ ] P2 wp.org listing: add the four screenshots or drop the section;
127-
fix Installation step order; add a Support section; align page-type
128-
lists with the detector; replace the stock `plugins/basicrum/README.md`
129-
stub. (privacy 6+7, UX 7 / DISC-08, DISC-09, BR-DOC-11, BR-DOC-14,
126+
- [x] P2 wp.org screenshots: add four current settings captures and matching
127+
numbered `readme.txt` captions. (UX 7 / BR-DOC-11)
128+
- [x] P2 wp.org listing: fix Installation step order; add a Support section;
129+
align page-type lists with the detector; replace the stock
130+
`plugins/basicrum/README.md`
131+
stub. (privacy 6+7, UX 7 / DISC-08, DISC-09, BR-DOC-14,
130132
BR-DOC-19)
131133
- [ ] P3 Soften or verify the "reviewed against Complianz" claim in the
132134
integrations README. (UX residual)

‎docs/audits/evidence.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ to the original privacy report:
8787
| CI-05 (UX 2, RESOLVED AFTER AUDIT) | major | `examples/integrations/cookieyes.js:4` | static | At audited ref: `sed -n '1,6p' examples/integrations/cookieyes.js` | At audited ref: `consentCategory='analytics'` was hard-coded with no warning in the file. Current packaged adapter includes the wrong-category warning. | medium |
8888
| BR-DOC-13 (UX 8) | major | no purge caveat on any shipped surface | static | `grep -ni 'purge\|cached' plugins/basicrum/readme.txt; echo exit=$?` | Exit 1; the non-shipped examples README does warn about cache clearing, the shipped surfaces do not | medium |
8989
| issue-http-strictness-inverted (UX 5, verifier-downgraded to minor) | minor | `Page.php:384,390`; `readme.txt:72-74` | static | `sed -n '384p;390p' plugins/basicrum/src/Admin/Settings/Page.php` | Label "HTTP Strictness" on a checkbox that relaxes strictness; readme FAQ repeats the inversion | medium |
90-
| BR-DOC-11 (UX 7, verifier-downgraded to minor) | minor | `readme.txt:76-81`; `wordpress-org-assets/` | static | `sed -n '76,81p' plugins/basicrum/readme.txt; ls wordpress-org-assets/` | Four screenshot captions, zero screenshot files in the repo | high |
90+
| BR-DOC-11 (UX 7, RESOLVED AFTER AUDIT) | minor | `readme.txt`; `wordpress-org-assets/` | static | `find wordpress-org-assets -maxdepth 1 -name 'screenshot-*.png'; sed -n '/== Screenshots ==/,/== Frequently Asked Questions ==/p' plugins/basicrum/readme.txt` | Current tree contains four WordPress 7.0.2 settings screenshots and four matching captions. | high |
9191

9292
## Runtime capture appendix
9393

‎docs/audits/operator-experience-audit.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -124,27 +124,27 @@ settings screen. (issue-backoffice-unlinked, walkthrough-05, BR-DOC-16)
124124

125125
## 7. Repair the wp.org listing surfaces
126126

127-
- [ ] readme.txt promises 4 screenshots; `wordpress-org-assets/` contains
128-
none. Capture screenshot-1..4.png or remove the section. (BR-DOC-11)
129-
- [ ] Installation steps 4-5 are in the reverse order of the UI dependency
127+
- [x] Add four current settings screenshots to `wordpress-org-assets/` and
128+
matching numbered captions to `readme.txt`. (BR-DOC-11)
129+
- [x] Installation steps 4-5 are in the reverse order of the UI dependency
130130
(fields unlock only after Enable is checked). (BR-DOC-14)
131-
- [ ] Add a Support section (wp.org forum, basicrum.com contact).
131+
- [x] Add a Support section (wp.org forum, basicrum.com contact).
132132
(BR-DOC-19)
133-
- [ ] Align page-type lists across surfaces with the detector (also privacy
133+
- [x] Align page-type lists across surfaces with the detector (also privacy
134134
audit item 6). (BR-DOC-22)
135-
- [ ] Replace the stock-template `plugins/basicrum/README.md` stub (also
135+
- [x] Replace the stock-template `plugins/basicrum/README.md` stub (also
136136
privacy audit item 7). (BR-DOC-21)
137-
- [ ] Keep the dev file `phpstan.neon.dist` out of the release ZIP.
137+
- [x] Keep the dev file `phpstan.neon.dist` out of the release ZIP.
138138
(BR-DOC-23)
139139

140140
## 8. Document the operating lifecycle
141141

142-
- [ ] State that disabling or deactivating Basicrum does not immediately
142+
- [x] State that disabling or deactivating Basicrum does not immediately
143143
stop the script on cached pages; tell operators to purge page/CDN caches
144144
(documentation side of privacy audit item 3). (BR-DOC-13)
145-
- [ ] State what deactivation keeps (settings) and uninstall removes.
145+
- [x] State what deactivation keeps (settings) and uninstall removes.
146146
(BR-DOC-17)
147-
- [ ] Add multisite guidance; network activation leaves every subsite
147+
- [x] Add multisite guidance; network activation leaves every subsite
148148
unconfigured. (BR-DOC-20)
149149

150150
## 9. Small engineering fixes

‎docs/audits/wporg-submission-checklist.md‎

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,42 +59,39 @@ refuters. 84 claims audited: 52 clean, 24 upheld findings, 8 overturned.
5959
itself: self-hosted collectors need no account. Reword: collector
6060
endpoint + Brum Site ID required; hosted account is one way to get
6161
them. (R24, C04)
62-
- [ ] Vocabulary bridge: the compliance FAQ says "immediate and
62+
- [x] Vocabulary bridge: the compliance FAQ says "immediate and
6363
consent-controlled loading" while the settings radios say "Monitor
6464
without consent" / "Require consent before monitoring". Bridge both
65-
vocabularies once, then use the radio labels. (C02)
66-
- [ ] Define the server-side nouns once: collector (receives beacons) vs
65+
vocabularies once, then use the radio labels. Resolved by removing the
66+
competing terminology. (C02)
67+
- [x] Define the server-side nouns once: collector (receives beacons) vs
6768
backoffice (dashboard where the Brum Site ID lives) vs account (hosted
68-
option); "backoffice" is currently undefined jargon. (C15)
69-
- [ ] Disambiguate "Basicrum" = plugin vs company vs service in the
69+
option); "backoffice" is currently undefined jargon. Resolved by using
70+
collector, Beacon URL, and hosted service consistently. (C15)
71+
- [x] Disambiguate "Basicrum" = plugin vs company vs service in the
7072
query-string FAQ: data goes only to the operator-configured Beacon URL;
7173
the plugin makes no requests to basicrum.com. (C16)
72-
- [ ] HTTP Strictness FAQ still inverts the semantics (enabling
74+
- [x] HTTP Strictness FAQ still inverts the semantics (enabling
7375
"Strictness" relaxes enforcement). Rewrite the FAQ to lead with the
7476
default (auto-upgrade to HTTPS) and what the toggle actually allows;
7577
the label rename remains open from the operator-experience audit. (C08)
7678
- [ ] "eligible pages" in the contributed privacy-policy text
7779
(Privacy.php immediate-mode sentence) is undefined for site owners;
7880
spell out: frontend pages, admins excluded unless Track Admin Users.
7981
(C12)
80-
- [ ] Define "connected" CookieYes at first use (linked to the CookieYes
81-
web app so its browser consent API is present). (C07)
82-
- [ ] Replace "fails closed" jargon: "keeps monitoring switched off until
83-
its consent API reports a decision". (C19)
84-
- [ ] "How it works" step 2 orders enable-before-Site-ID, contradicting
85-
Installation steps 4-5 and triggering the enabled-but-inactive notice;
86-
align the order. (C22)
87-
- [ ] "after the configured Script Position" forward-references an
88-
undefined setting; name it: Basicrum > Performance > Script Position
89-
(header or footer). (C23)
82+
- [x] Define "connected" CookieYes at first use. Resolved by removing the
83+
ambiguous implementation detail from the customer-facing overview. (C07)
84+
- [x] Replace "fails closed" jargon with plain language. (C19)
85+
- [x] Align the installation order with the enabled-field dependency and
86+
remove the redundant "How it works" sequence. (C22)
87+
- [x] Remove the undefined Script Position forward reference from the
88+
consent overview. (C23)
9089

9190
## 4. Optional but recommended
9291

93-
- [ ] Screenshots: the section was correctly removed (no files existed),
94-
but an image-free listing forces users to imagine the settings-driven
95-
consent workflow. Capture screenshot-1..N.png using the exact current
96-
labels (Visitor Consent, Consent Tool Connection) and restore a
97-
matching section. (C24)
92+
- [x] Screenshots: four current WordPress 7.0.2 settings captures use the exact
93+
Visitor Consent and Consent Tool Connection labels, privacy-safe example
94+
values, and matching numbered captions in `readme.txt`. (C24)
9895
- [ ] Spot-check the two basicrum.com URLs (home, /contact/) resolve;
9996
reviewers click them. (R45)
10097
- [ ] CookieYes "modern ... runtime" - one refuter pair split on this;

0 commit comments

Comments
 (0)