orangecat/faqs

FAQs Module with product relation and structured data

Maintainers

Details

github.com/olivertar/m2_faqs_ai

Source

Issues

Installs: 2

Dependents: 1

Suggesters: 0

Security: 0

Stars: 0

Watchers: 0

Forks: 0

Open Issues: 0

Type:magento2-module

pkg:composer/orangecat/faqs

1.0.1 2025-11-30 18:32 UTC

Requires

OSL-3.0 2bae48e0de2525513143160e2ea19844b43138a4

This package is auto-updated.

Last update: 2025-11-30 18:34:50 UTC

README

The Orangecat FAQs module is a powerful tool designed to manage Frequently Asked Questions (FAQs) within your Magento 2 store. It is explicitly engineered to facilitate the work of AI Crawlers (like ChatGPT, Google Gemini, etc.) by providing rich, structured data and optimized content delivery.

Key Features

  • AI Crawler Optimized: Automatically generates JSON-LD Structured Data (Schema.org) for all FAQs. This ensures that AI bots and search engines can easily parse and understand your content, increasing the likelihood of your FAQs appearing in rich snippets and AI-generated answers.
  • Multistore & Multilanguage: Fully supports multiple store views and languages. You can create specific FAQs for different regions or languages.
  • AI Translation Ready: Built with an architecture that seamlessly integrates with AI translation tools (such as the Orangecat Translate AI module), allowing for automated, high-quality translations of your FAQ content.
  • Product Relations: Assign FAQs to specific products. These FAQs will automatically appear on the Product Detail Page (PDP) in a dedicated tab or section, providing relevant information right where the customer needs it.
  • Flexible Display Modes:
    • Single Page: Displays all FAQs on a single page with an accordion layout. Ideal for stores with a smaller number of FAQs (< 50).
    • Multi Page: Creates a dedicated page for each FAQ category. Recommended for stores with a large knowledge base (> 50 FAQs).
  • SEO Friendly: Includes customizable URL keys and suffixes for FAQ pages.

Theme Compatibility

This module is compatible with the following Magento 2 themes:

  • Luma (Magento default theme)
  • Breeze (Lightweight performance theme)
  • Hyvä (Modern Alpine.js + Tailwind CSS theme)

Each theme has optimized templates and styling to ensure a seamless integration with your store's design.

Configuration

You can configure the module settings in Stores > Configuration > Orange Cat > FAQs.

General

  • Enable FAQ Page: Enable or disable the main FAQ index page.
  • Enable FAQ Feed: Enable the generation of a dedicated feed for AI crawlers (requires Orangecat_Feed module).
  • Enable FAQ PDP: Show relevant FAQs on product pages.

FAQ Section

  • Section FAQs Title: The main title for your FAQ page (e.g., "Help Center", "Frequently Asked Questions").
  • Path: The URL path for the FAQ home page (e.g., faqs).
  • URL Suffix: The suffix for FAQ pages (e.g., .html).
  • Display Mode: Choose between Single Page (Accordion) or Multi Page (Grid/List).
  • FAQs Per Page: (Multi Page mode only) Number of questions to show per page.
  • Intro CMS Block: Select a CMS block to display as an introduction on the FAQ main page.
  • Link Label: Custom label for the FAQ link in menus.
  • Show FAQ Link in Top Menu: Add a link to the FAQs in the main navigation menu.
  • Show FAQ Link in Footer Links: Add a link to the FAQs in the footer.

For Developers

Structured Data

The module automatically injects LD+JSON scripts into the head of FAQ pages and Product pages.

  • FAQ Page: Uses FAQPage schema.
  • Product Page: Adds QAPage or FAQPage schema related to the product.

Integration

This module is designed to work with the Orangecat Ecosystem:

  • Orangecat_Feed: To export FAQs in a machine-readable format for external AI training.
  • Orangecat_TranslateAi: To automatically translate FAQ questions and answers using LLMs (DeepSeek, OpenAI).