Documentation · Admin Reference

Support Reference

This document is a reference for the Support screen of the ADP Car Market Hub plugin (Car Market Hub → Support). It covers the AI Support Assistant, the contact-escalation form, the documentation links and the local knowledge-base controls.

When to use this document

Read this if you need to:

  • Ask a question about the plugin and get an answer grounded in the official knowledge base.
  • Open a structured support ticket when the assistant cannot resolve the issue.
  • Find the official documentation sections and the full documentation repository.
  • Manage the local AI knowledge index and the cached external documentation.
  • Look up answers to the most common questions in the built-in FAQ.

Overview

The Support screen is the central help hub. A row of status (KPI) cards across the top summarises the installation at a glance, followed by the main cards:

  • Status cards — Plugin Version, License (plan and operational state), Last Updated, Support Status (Operational, N recent errors, or Attention required) and Knowledge Base (number of indexed entries).
  • AI Support Assistant — chat interface backed by a managed AI provider, grounded in the local plugin knowledge base and (optionally) cached official documentation.
  • Contact Escalation — structured ticket form that emails the ADP support team, with optional automatic diagnostics attachment.
  • Documentation & Resources — links to the official documentation sections and the full documentation repository.
  • Knowledge & Cache — counters and maintenance buttons for the local AI knowledge base and the external documentation cache.
  • Quick Troubleshooting & FAQ — short curated answers to the most common questions.

Requirements or prerequisites

  • A user with the plugin's management capability.
  • For the AI Support Assistant and external documentation cache: outbound HTTPS access from the web server.
  • For the contact form: a working WordPress mail configuration (typically an SMTP plugin or a host-managed mail relay).
  • Cookies and JavaScript enabled in the admin browser session (the assistant and the form rely on AJAX).

Step by step instructions

Ask the AI Support Assistant

  1. Open Car Market Hub → Support.
  2. In the AI Support Assistant card, type your question in your own words.
  3. Click Ask AI or press Ctrl + Enter (or Cmd + Enter on macOS).
  4. The reply renders in the conversation panel. When the answer references documentation pages, the source list is shown beneath it.

The assistant prefers answers from the local knowledge base and falls back to the cached external documentation when needed. The active admin tab is sent as context so the answer can be biased towards the area you are currently working in. The assistant attempts to reply in your WordPress admin language; if you write in a different language, it follows your message language.

Open a support ticket

  1. Scroll to Contact Escalation.
  2. Fill in Name, Email, Subject and Message. Name and email are pre-filled from your WordPress profile.
  3. Choose a Priority (Low, Normal (default), High, Urgent).
  4. Leave Attach system diagnostics automatically enabled if you want the plugin log and the WordPress debug.log to be attached (each capped at 2 MB).
  5. Click Submit Ticket. A status message confirms the result inline.

Open official documentation

  1. Use the Documentation & Resources card to open: - Getting Started — first steps and initial configuration. - Admin Reference — reference for each admin screen. - Troubleshooting & FAQ — answers to common problems and questions. - Frontend Guide — the visitor-facing search, listings and detail pages. - Operations & Maintenance — day-to-day running, imports and upkeep. - Support Information Checklist — what to gather before contacting support. - Full Documentation — the complete documentation repository.

Each link opens in a new browser tab.

Maintain the AI knowledge base and documentation cache

  1. In the Knowledge & Cache card, review the counters: - Local KB entries — number of locally indexed knowledge entries. - Indexed Q&A pairs — number of Q&A pairs that the assistant can match against. - Cached docs — cached / total external documentation pages stored locally.
  2. Use the buttons: - Rebuild AI Knowledge Index — re-index the local knowledge base from source. - Refresh Documentation Cache — re-download the external documentation pages. - Clear Documentation Cache — remove the cached external documentation. Destructive.

Use the FAQ

  1. Open Quick Troubleshooting & FAQ at the bottom of the screen.
  2. Click any question to expand the answer. Categories are shown at the bottom of each entry where set.

Configuration reference

The Support screen does not store its own configuration. It exposes runtime status and direct actions.

Contact form fields

FieldRequiredNotes
NameYesPre-filled from the current user profile.
EmailYesPre-filled from the current user profile.
SubjectYesPlain text.
PriorityNoOne of Low, Normal, High, Urgent. Defaults to Normal.
MessageYesPlain text.
Attach system diagnostics automaticallyNoDefault on. Attaches the plugin log and WordPress debug.log (max 2 MB each).

Knowledge & Cache controls

ControlEffect
Rebuild AI Knowledge IndexRe-creates the local knowledge index used to ground the assistant.
Refresh Documentation CacheRe-downloads the external documentation snapshot.
Clear Documentation CacheEmpties the cached external documentation (the assistant will then rely on the local KB only).

Operational notes

  • The AI Assistant calls a managed AI provider through the plugin. No raw end-customer data is sent unless you explicitly type it into the chat.
  • The contact form sends its message and any attached diagnostics to a fixed ADP support address via WordPress mail; this destination is not site-configurable. Delivery depends on your site's mail configuration.
  • The diagnostics attachment is intended to help reproduce issues quickly. Each attachment is capped at 2 MB. If your log exceeds this, only the most recent portion is included.
  • The local knowledge base is shipped with the plugin and is rebuilt from source files. The external documentation cache is fetched from the official documentation repository and stored locally so GitHub is not queried on every question.
  • The assistant always recommends opening a support ticket when it is uncertain — treat that as an explicit signal, not as a failure.

Troubleshooting

  • The assistant returns an error. Confirm outbound HTTPS access from the server. Open the browser console for a more specific error. Try again after a short delay; transient upstream errors are common.
  • The contact form reports a failure. WordPress mail is not configured. Install a transactional mail plugin (or have your host configure SMTP) and resubmit.
  • Diagnostics attachment is missing. Either the log files were not readable, or each one exceeded 2 MB and was skipped. Check the log file path on System And Help Reference.
  • Cached docs counter shows 0 / N. External documentation has not been fetched yet. Click Refresh Documentation Cache.
  • Rebuild AI Knowledge Index reports zero entries. Verify the plugin files are intact. Reinstall the plugin if needed.
  • Resource links open the wrong page. The cache may be outdated; click Refresh Documentation Cache and reload the screen.