Skip to content

docs: fold readme Privacy section into a FAQ entry#1203

Open
kilbot wants to merge 2 commits into
mainfrom
fix/readme-privacy-faq
Open

docs: fold readme Privacy section into a FAQ entry#1203
kilbot wants to merge 2 commits into
mainfrom
fix/readme-privacy-faq

Conversation

@kilbot

@kilbot kilbot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up to #1202. Removes the standalone == Privacy == section from readme.txt and folds the required external-services disclosure into a single FAQ entry ("What data does WCPOS send outside my site?").

  • Same disclosures retained — jsDelivr (translations), opt-in wcpos.com analytics, Pro license activation + site identifier — now in one tight paragraph.
  • Keeps the plugin compliant with WordPress.org Guideline 7 (tracking/consent disclosure) and Guideline 6 (external services documented in readme), without a wall of privacy text competing with the marketing copy.
  • Net change: readme is ~7 lines shorter; no other sections touched.

Design decisions (preserve through rebases)

  • The == Privacy == heading is intentionally removed — WordPress.org mandates the disclosure, not a dedicated section. Folding it into the FAQ is deliberate, not an accidental deletion of a compliance section.

Test plan

  • Render readme.txt through the wordpress.org readme validator/preview; confirm the FAQ shows the new entry and there is no == Privacy == section.
  • Confirm the privacy-policy link (https://wcpos.com/privacy) resolves.
  • Confirm the disclosure still names jsDelivr, opt-in analytics, and Pro license activation.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the FAQ with a clearer privacy/data-sharing entry.
    • Added a short explanation of which external services may be contacted, including translations, optional analytics, and license validation.
    • Removed the longer standalone privacy section and now direct readers to the privacy policy for full details.

Remove the standalone == Privacy == section and move the external-services
disclosure (jsDelivr, opt-in analytics, Pro license activation) into one FAQ
answer. Satisfies WordPress.org Guidelines 6 & 7 without a wall of privacy
text competing with the marketing copy.

@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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: c22237b5-0985-4aa3-8ddd-289e34e3a9b0

📥 Commits

Reviewing files that changed from the base of the PR and between c16d540 and fa36a77.

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

📝 Walkthrough

Walkthrough

The readme.txt file's privacy documentation was restructured. The standalone "== Privacy ==" section was removed and replaced with a new FAQ entry explaining external services contacted by WCPOS, including translation CDN, opt-in analytics, and Pro license validation data.

Changes

Readme documentation update

Layer / File(s) Summary
Privacy FAQ entry replacement
readme.txt
Replaces the standalone "Privacy" section with a new FAQ entry, "What data does WCPOS send outside my site?", covering jsDelivr translations, consent-gated analytics, and Pro license validation identifiers, with a pointer to the full privacy policy.

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

Compact Metadata

Related issues: None found
Related PRs: None found
Suggested labels: documentation
Suggested reviewers: None suggested

Curious paws tap gently on the keys,
A privacy note now reads with ease.
No more long sections, just a tidy FAQ,
Where data flows are clearly laid.
One small hop for readme, one giant leap for clarity! 🐰📄

🚥 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 describes the main documentation change: moving the readme privacy content into a FAQ entry.
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-privacy-faq

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: 9235ae5bda

ℹ️ 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
@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:116 Logic Privacy/external-services disclosure regression Fix Add the anonymous identifier to the existing folded FAQ entry without restoring == Privacy ==.

Skipped threads: none. Fresh GraphQL review-thread inventory returned 1 unresolved thread, and this is the thread being fixed.

@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

Review-fix triage after push:

Thread File Issue Decision Commit
3540166179 readme.txt Folded FAQ omitted the anonymous identifier sent with Pro license activation. Fixed and resolved. fa36a77

Excluded threads:

Thread Reason for skipping
None Fresh post-push GraphQL inventory reports 0 unresolved review threads.

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