Skip to content

docs: add Delete by Country section to visitors docs#55

Merged
guibranco merged 4 commits into
mainfrom
feature/update-docs
May 12, 2026
Merged

docs: add Delete by Country section to visitors docs#55
guibranco merged 4 commits into
mainfrom
feature/update-docs

Conversation

@guibranco
Copy link
Copy Markdown
Owner

@guibranco guibranco commented May 12, 2026

📑 Description

Document the Delete by Country feature, including step-by-step usage, bulk deletion support, and audit log fields. Add a corresponding row to the privacy controls table in privacy.md.

✅ Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

☢️ Does this introduce a breaking change?

  • Yes
  • No

Summary by Sourcery

Document the new Delete by Country functionality for visitor records and align privacy documentation accordingly.

Documentation:

  • Add a Visitors guide section describing Delete by Country usage, bulk deletion behavior, and related audit logging details.
  • Clarify irreversibility and scope of country-based deletions and how countries appear in the deletion dropdown.

Summary by CodeRabbit

  • Documentation
    • Added “Delete by country” / GDPR right-to-erasure docs: bulk country-based deletion with confirmation dialog showing affected counts.
    • Described irreversible workflow, country selector behavior (only countries with records), single-transaction bulk deletion, and 90-day audit log retention.
    • Updated privacy guidance and examples for using the new erasure option.

Review Change Stack

Document the Delete by Country feature, including step-by-step
usage, bulk deletion support, and audit log fields. Add a
corresponding row to the privacy controls table in privacy.md.
@sourcery-ai
Copy link
Copy Markdown

sourcery-ai Bot commented May 12, 2026

Reviewer's Guide

Adds documentation for the new "Delete by Country" feature in visitors.md, detailing usage, bulk deletion behavior, and audit logging, and integrates it into the existing visitors documentation flow.

File-Level Changes

Change Details Files
Document the Delete by Country workflow for visitor records, including behavior, safeguards, and logging.
  • Added a new "Deleting records by country" section describing the feature purpose and GDPR/right-to-erasure context.
  • Documented step-by-step UI workflow for selecting countries, confirming, and executing deletions from the Visitors screen.
  • Explained bulk deletion semantics, noting multiple-country selection and single-transaction behavior.
  • Described the audit log fields recorded for each delete-by-country action, including action name, countries, record count, actor, and timestamp.
  • Added warnings about irreversibility of country-filter deletions and notes about country dropdown entries being limited to countries with existing records.
docs/visitors.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@guibranco guibranco enabled auto-merge (squash) May 12, 2026 17:12
@gstraccini gstraccini Bot added the ☑️ auto-merge Automatic merging of pull requests (gstraccini-bot) label May 12, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 09f27599-1272-483b-aeee-900c28fd4b6c

📥 Commits

Reviewing files that changed from the base of the PR and between 8064160 and e77b81c.

📒 Files selected for processing (2)
  • docs/index.md
  • docs/privacy.md
✅ Files skipped from review due to trivial changes (1)
  • docs/index.md

Walkthrough

Adds documentation for a GDPR "Delete by country" erasure feature: a new control entry, a visitors guide section describing selecting countries, confirmation with affected counts, single-transaction bulk deletion, and auditable deletion logs retained for 90 days; also updates the PHP example for programmatic usage.

Changes

Delete by Country Feature Documentation

Layer / File(s) Summary
Privacy controls table entry
docs/privacy.md
Adds a "Delete by country" row to the Available controls table describing bulk deletion by selected countries with confirmation and action logging.
GDPR right-to-erasure by country
docs/privacy.md
New section describing selection by stored country_code, bulk behavior, mandatory confirmation showing affected countries and record counts, and audit logging (operator, country list, record count, UTC timestamp).
Programmatic erasure examples
docs/privacy.md
Updates PHP example to include IpQuery_DB::delete_by_country('DE') and IpQuery_DB::delete_by_countries([...]) and notes WordPress privacy tooling support is planned.
Visitors guide: deleting records by country
docs/visitors.md
Adds full "Deleting records by country" instructions: select countries, confirm deletion with affected counts, perform single-transaction bulk deletion, audit log format/location and 90-day retention, irreversibility warning, and country dropdown constraint.
Docs index feature list
docs/index.md
Adds "GDPR erasure by country" row to the features table referencing bulk-delete confirmation and audit logging.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 I nibble on docs, tidy and spry,
Countries cleared as records say bye,
A log keeps the tale in neat little rows,
Counters echo how many it knows,
GDPR hops softly — privacy high.

🚥 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 PR title accurately summarizes the main change: adding documentation for the Delete by Country feature in the visitors documentation.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch feature/update-docs

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@penify-dev
Copy link
Copy Markdown

penify-dev Bot commented May 12, 2026

Failed to generate code suggestions for PR

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Document the Delete by Country tool and its GDPR Article 17
workflow: targeted bulk deletion, confirmation dialog, and
audit logging. Add `delete_by_country` and
`delete_by_countries` API examples alongside existing
`delete_ip` snippet.
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
docs/privacy.md (1)

60-60: ⚡ Quick win

Add a direct docs link for faster navigation.

Consider linking this row to the detailed “Deleting records by country” section so operators can jump straight to procedure/audit details.

🤖 Prompt for 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.

In `@docs/privacy.md` at line 60, Update the table row that reads "**Delete by
country** | Visitors screen → Delete by Country | Bulk-removes all records..."
to include an internal markdown anchor link pointing to the detailed "Deleting
records by country" section so operators can jump directly to that section;
modify the cell containing "Delete by Country" (or the whole row link) to use
standard markdown link syntax with the section anchor (e.g., [Delete by
Country](`#deleting-records-by-country`)) so the table entry navigates to the
detailed procedure/audit details.
🤖 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.

Nitpick comments:
In `@docs/privacy.md`:
- Line 60: Update the table row that reads "**Delete by country** | Visitors
screen → Delete by Country | Bulk-removes all records..." to include an internal
markdown anchor link pointing to the detailed "Deleting records by country"
section so operators can jump directly to that section; modify the cell
containing "Delete by Country" (or the whole row link) to use standard markdown
link syntax with the section anchor (e.g., [Delete by
Country](`#deleting-records-by-country`)) so the table entry navigates to the
detailed procedure/audit details.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 5cf38df8-f717-40a3-9a8e-559ac3685664

📥 Commits

Reviewing files that changed from the base of the PR and between 85ac798 and 8064160.

📒 Files selected for processing (2)
  • docs/privacy.md
  • docs/visitors.md

Include the new GDPR erasure feature in the features
table of the documentation. This update highlights the
ability to bulk-delete visitor records by country, a feature
that includes a confirmation dialog and audit log. This
enhancement is important for compliance with privacy
regulations and provides users with a critical tool for
managing visitor data according to geographic privacy
requirements.
@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown
Contributor

✅ WordPress Plugin Check Report

✅ Status: Passed

📊 Report

All checks passed! No errors or warnings found.


🤖 Generated by WordPress Plugin Check Action • Learn more about Plugin Check

@guibranco guibranco merged commit c8a5b24 into main May 12, 2026
15 of 16 checks passed
@guibranco guibranco deleted the feature/update-docs branch May 12, 2026 17:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

☑️ auto-merge Automatic merging of pull requests (gstraccini-bot)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants