Skip to content

docs: Add Tags documentation for Contact management#647

Open
promptless-for-oss wants to merge 3 commits into
mautic:5.2from
Promptless:promptless/add-tags-documentation
Open

docs: Add Tags documentation for Contact management#647
promptless-for-oss wants to merge 3 commits into
mautic:5.2from
Promptless:promptless/add-tags-documentation

Conversation

@promptless-for-oss
Copy link
Copy Markdown

Open this suggestion in Promptless to view citations and reasoning process

Creates comprehensive documentation for Tags in Mautic. The new tags.rst page covers creating and managing Tags, adding Tags to Contacts manually and via batch updates, using Tags in Campaigns (Modify Contact's Tags action, Contact Tags condition), using Tags in Forms and Segments, Tag search syntax, and best practices for Tag taxonomy.

Trigger Events

Web UI: Can you check if there is any missing documentation

Agent Response

I've completed a comprehensive review of the Mautic documentation and identified three key documentation gaps. I've created documentation suggestions to address each one:

Summary of Documentation Gaps Found and Addressed

1. Tags Documentation (New Page) ✅

Gap Found: Tags are used throughout Mautic (Campaigns, Forms, Segments) but there was no dedicated documentation explaining what Tags are or how to use them.

Created: New docs/contacts/tags.rst covering:

  • What Tags are and how they differ from Segments
  • Creating and managing Tags
  • Using Tags in Campaigns (Modify Contact's Tags action, Contact Tags condition)
  • Using Tags in Forms
  • Using Tags as Segment filters
  • Tag search syntax
  • Best practices for Tag taxonomy

2. Webhooks Documentation (New Page) ✅

Gap Found: Webhooks are mentioned in cron jobs and settings, but there was no documentation explaining how to actually create and configure Webhooks.

Created: New docs/configuration/webhooks.rst covering:

  • Creating and configuring Webhooks
  • All available Webhook events (Contact, Email, Form, Page)
  • Example JSON payload structure
  • Global Webhook settings and queue mode
  • Cron job setup for queued Webhooks
  • Troubleshooting common issues
  • Performance and security considerations

3. A/B Testing Documentation (Enhanced Section) ✅

Gap Found: A/B testing was only briefly mentioned in the Emails documentation (just about previewing variants), with no comprehensive guide.

Enhanced: Added comprehensive A/B testing section to docs/channels/emails.rst covering:

  • Step-by-step setup instructions
  • What elements to test (subject lines, sender name, content, images, CTAs)
  • How to analyze A/B test results
  • Best practices for effective testing

Features That Were Already Well Documented

My review also confirmed these areas are adequately documented:

  • Point Groups, Event cloning, Export permissions, Custom fonts in GrapesJS
  • SAML/SSO authentication, Do Not Contact

...truncated. See dashboard for full response.


Tip: Set up a GitHub Issues trigger in Projects to enable @Promptless mentions in issues 🐙

Signed-off-by: promptless-for-oss <promptless-for-oss@users.noreply.github.com>
@promptless-for-oss promptless-for-oss requested a review from a team as a code owner February 24, 2026 09:55
@promptless-for-oss promptless-for-oss requested review from adiati98 and favour-chibueze and removed request for a team February 24, 2026 09:55
Comment thread docs/contacts/tags.rst
@@ -0,0 +1,125 @@
.. vale off
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Citation: Referenced Modify Contact's tags action and Contact Tags condition from the Campaign Builder documentation to ensure consistency in describing Tags usage within Campaigns.
View source

Comment thread docs/contacts/tags.rst
@@ -0,0 +1,125 @@
.. vale off
Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

Citation: Referenced the Modify Contact's Tags Form action documentation to ensure consistency in describing Tags usage within Forms.
View source

RCheesley
RCheesley previously approved these changes Apr 3, 2026
Copy link
Copy Markdown
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

Looks good!

Copy link
Copy Markdown
Contributor

@adiati98 adiati98 left a comment

Choose a reason for hiding this comment

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

@promptless-for-oss there are some reviews for you to address.

Comment thread docs/contacts/tags.rst
Comment thread docs/contacts/tags.rst
Comment thread docs/contacts/tags.rst
Comment thread docs/contacts/tags.rst
Comment thread docs/contacts/tags.rst Outdated
Comment thread docs/contacts/tags.rst Outdated
Comment thread docs/contacts/tags.rst Outdated
Comment thread docs/contacts/tags.rst Outdated
Comment thread docs/contacts/tags.rst Outdated
Comment thread docs/contacts/tags.rst Outdated
@adiati98
Copy link
Copy Markdown
Contributor

@promptless-for-oss please address the suggestions

@promptless-for-oss
Copy link
Copy Markdown
Author

@adiati98 I've addressed all the review suggestions:

  1. Added vale off/on wrappers around section headings and the Manual assignment steps (where "form" is generic)
  2. Changed "Configure which Tags to validate" → "Configure which Tags to check for"
  3. Changed ordered lists to use #. format
  4. Changed unordered lists to use *
  5. Changed double quotes to single quotes in best practices examples
  6. Removed colons before code examples in search syntax

The changes are ready for your review.

Co-authored-by: Ayu Adiati <45172775+adiati98@users.noreply.github.com>
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.

3 participants