Skip to content

docs: polish wordpress.org readme for marketing and conversion#1202

Merged
kilbot merged 6 commits into
mainfrom
fix/readme-marketing-polish
Jul 7, 2026
Merged

docs: polish wordpress.org readme for marketing and conversion#1202
kilbot merged 6 commits into
mainfrom
fix/readme-marketing-polish

Conversation

@kilbot

@kilbot kilbot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Marketing/conversion polish of the wordpress.org listing (readme.txt). No runtime code changes.

  • Trimmed the oversized privacy notice to a concise, wordpress.org-compliant disclosure: names the two external touchpoints (jsDelivr translations, opt-in wcpos.com analytics), keeps the "no data sold or shared" promise, and links the full policy at wcpos.com/privacy. Moved WP-CLI power-user trivia out of the listing.
  • Rewrote the FAQ. Removed the three dead links (wcpos.com/faq → now 301s to docs, wcpos.com/docs, and the non-existent /blog). Replaced with buyer-focused Q&As that double as conversion copy: is it really free, offline, what hardware, can I take card payments, free vs Pro, live demo, and where to get help (docs.wcpos.com + Discord).
  • Sharpened positioning. New short description and Description opening lead with a clear value hook ("turn any device into a register — same catalog, stock and prices, online or off") instead of "a simple application for taking orders."
  • Surfaced payment terminals in the Pro list — Stripe Terminal + SumUp were the strongest upgrade reason and weren't listed at all — and named popular gateways (Stripe, PayPal, Square, Mollie) on the existing "any gateway" bullet.

Design decisions (preserve through rebases)

  • No pricing figures and no store-count/social-proof numbers in the listing — deliberate, per maintainer direction. Don't "helpfully" add $129/yr or 5,000+ stores back in.
  • Kept a single "formerly WooCommerce POS" reference for search/discovery of the old name — intentional exception to the WCPOS-only naming rule, not a naming slip.
  • Privacy section trimmed, not removed — a disclosure is required by wordpress.org guidelines because the plugin uses external services (jsDelivr CDN) and opt-in analytics. Full removal would risk the listing.

Follow-ups (not in this PR)

  • Tested up to: 7.0 in the header looks wrong (WordPress 7.0 doesn't exist yet) — left unchanged pending confirmation of the actual tested version.
  • Only one screenshot is defined (1. WCPOS main screen). Adding 4–6 (POS grid, cart/checkout, receipt gallery, printer setup, mobile) is likely the single biggest wordpress.org conversion lever, but requires image assets — out of scope here.

Test plan

  • Render readme.txt through the wordpress.org readme validator / preview and confirm no formatting breakage.
  • Confirm all links resolve: demo.wcpos.com/pos, docs.wcpos.com, wcpos.com/pro, wcpos.com/discord, wcpos.com/privacy.
  • Confirm the short description is within the 150-char limit and reads well in search results.
  • Sanity-check the Pro feature claims (Stripe Terminal, SumUp, and named gateways) match what Pro actually ships.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the product description to clarify POS access across web and native apps, including offline continuity and the prior name.
    • Expanded and refreshed the FAQ covering pricing/free status, required components, supported devices, offline behavior, hardware needs, card payments, Free vs Pro, trial/install, and support.
    • Updated the privacy information with clearer data-flow details, including on-demand translation loading, opt-in anonymous analytics, Pro license activation, and a refreshed privacy policy link.

- Trim oversized privacy notice to a concise, compliant disclosure
  (external services + opt-in analytics) linking the full policy
- Rewrite FAQ: drop dead wcpos.com/faq, /docs, /blog links; add
  buyer-focused Q&As (free vs pro, offline, hardware, card payments,
  demo, support pointing at docs.wcpos.com + Discord)
- Sharpen the short description and Description opening with a clearer
  positioning hook
- Surface payment terminals (Stripe Terminal, SumUp) and popular
  gateways (Stripe, PayPal, Square, Mollie) in the Pro feature list

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kilbot has reached the 50-credit limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)
  • .wordpress-org/banner-1544x500.jpg is excluded by !**/*.jpg
  • .wordpress-org/banner-772x250.jpg is excluded by !**/*.jpg

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

⚙️ Run configuration

Configuration used: Repository: wcpos/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 00c64820-b05b-4692-bb01-66cd80e52a26

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

The readme.txt content was updated with revised product description text, adjusted PRO payment feature bullets, and a larger FAQ plus rewritten Privacy section covering translation loading, analytics consent, and Pro license activation.

Changes

Readme copy updates

Layer / File(s) Summary
Description and PRO feature bullets
readme.txt
Top-level description rewritten to emphasize turning any device into a POS with continuity offline; PRO features list updated with a new "Payment Terminals" bullet and reworded "Payment Gateways" bullet.
FAQ and Privacy expansion
readme.txt
FAQ section expanded with new Q&A entries covering cost, requirements, devices, offline behavior, and support; Privacy section rewritten to describe CDN translation loading, opt-in anonymous analytics (wcpos_anon_id), and Pro license activation requests.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Related PRs: None referenced.

Suggested labels: documentation

Suggested reviewers: None identified from the provided information.

Would you like the privacy wording checked against the implementation details for translation loading, analytics consent, and license activation?

Poem

A readme’s words were freshened here,
With FAQs and privacy clear,
Payments gained a terminal cue,
And gateways got wording new,
A docs-only shift, concise and near.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the README-focused marketing and conversion copy updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/readme-marketing-polish

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a056b95b9d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread readme.txt Outdated
Comment thread readme.txt Outdated
Comment thread readme.txt Outdated
@wcpos-bot

wcpos-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review-fix triage before changes:

# Source File Class Category Decision Outcome
1 chatgpt-codex-connector readme.txt Logic Marketing/privacy accuracy Fix Add Pro license activation request/identity handoff to privacy disclosure.
2 chatgpt-codex-connector readme.txt Logic Marketing/offline accuracy Fix Limit offline claim to local product browsing/cart prep and reconnect-to-checkout.
3 chatgpt-codex-connector readme.txt Logic Marketing/payment compatibility accuracy Fix Narrow Pro payment claim to supported gateways and named terminal integrations.

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kilbot has reached the 50-credit limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@wcpos-bot

wcpos-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Post-fix triage table:

Thread File Issue Decision Commit
3537235632 readme.txt Privacy copy omitted Pro license activation requests and identity handoff. Fixed and resolved c0d78c2
3537235638 readme.txt Offline FAQ promised automatic order sync. Fixed and resolved 49158ed
3537235645 readme.txt Pro FAQ promised any payment gateway or terminal. Fixed and resolved eab80c2

Skipped threads: none.

Remaining unresolved inline review threads after re-query: 0.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@readme.txt`:
- Around line 10-14: The README wording in the WCPOS description overstates
offline capability; update the copy in the main description to match the
documented behavior. Specifically, adjust the “keep selling even when the
internet drops” claim so it only promises offline browsing/cart building unless
full offline checkout is actually supported, and keep the phrasing aligned with
the FAQ and WCPOS positioning.
- Around line 121-127: Update the privacy copy in the section describing WCPOS
data flows so it matches the actual transfers listed above: replace the broad
“No data is ever sold or shared” claim with a narrower statement that references
transfers to third-party/service providers such as jsDelivr and wcpos.com. Keep
the wording aligned with the existing bullets in the readme text and ensure the
change reflects the translation, analytics, and license activation disclosures
already described.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository: wcpos/coderabbit/.coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: ecbec569-ca94-428f-b092-be98f0ee071d

📥 Commits

Reviewing files that changed from the base of the PR and between 6110429 and c0d78c2.

📒 Files selected for processing (1)
  • readme.txt

Comment thread readme.txt Outdated
Comment thread readme.txt Outdated
@wcpos-bot

wcpos-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review-fix triage before changes:

# Source File Class Category Decision Outcome
1 CodeRabbit readme.txt Logic Marketing/offline accuracy Fix Narrow the description claim to offline product browsing and cart building; checkout still requires reconnect.
2 CodeRabbit readme.txt Logic Privacy disclosure accuracy Fix Replace the broad sold/shared statement with wording limited to the listed service-provider transfers: jsDelivr and wcpos.com.

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kilbot has reached the 50-credit limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@wcpos-bot

wcpos-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Post-fix triage table:

Thread File Issue Decision Commit
3537352603 readme.txt Description over-promised offline selling beyond browsing/cart building. Fixed and resolved 8eac9f6
3537352610 readme.txt Privacy footer used a broad sold/shared claim despite listed service-provider transfers. Fixed and resolved 8eac9f6

Skipped threads: none.

Remaining unresolved inline review threads after re-query: 0.

@wcpos-bot

wcpos-bot Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Post-fix triage table:

Thread File Issue Decision Commit
3537352603 readme.txt Description over-promised offline selling during connection drops. Fixed and resolved 8eac9f6
3537352610 readme.txt Privacy footer used a broad sold/shared claim despite listed transfers to jsDelivr and wcpos.com. Fixed and resolved 8eac9f6

Skipped threads: none.

Remaining unresolved inline review threads after fresh GraphQL re-query: 0.

Replace the old low-res storefront banner with a bright top-down counter
shot showing the WCPOS POS in use (tablet, thermal printer, card terminal,
scanner). Adds the WCPOS logo mark, a red 'Point of Sale for WooCommerce'
eyebrow and the Geist headline over a soft top wash, matching the
wcpos.com hero. Both the 772x250 standard and 1544x500 retina sizes.

@greptile-apps greptile-apps Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kilbot has reached the 50-credit limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@kilbot kilbot merged commit c16d540 into main Jul 7, 2026
16 checks passed
@kilbot kilbot deleted the fix/readme-marketing-polish branch July 7, 2026 22:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant