PHPackages                             orangecat/faqs - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. orangecat/faqs

ActiveMagento2-module

orangecat/faqs
==============

FAQs Module with product relation and structured data

1.0.2(5mo ago)541OSL-3.0PHPPHP ^7.4 || ^8.1

Since Nov 30Pushed 5mo ago1 watchersCompare

[ Source](https://github.com/olivertar/m2_faqs_ai)[ Packagist](https://packagist.org/packages/orangecat/faqs)[ RSS](/packages/orangecat-faqs/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (3)Dependencies (3)Versions (5)Used By (1)

Orangecat FAQs Module
=====================

[](#orangecat-faqs-module)

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
------------

[](#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
-------------------

[](#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
-------------

[](#configuration)

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

### General

[](#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

[](#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.

GraphQL API (Headless)
----------------------

[](#graphql-api-headless)

The module provides a complete **GraphQL API** for headless frontends (PWA Studio, React, Vue, etc.):

### Product FAQs

[](#product-faqs)

Fetch FAQs assigned to products with type filtering:

- `PDP`: FAQs visible on Product Detail Page
- `FEED`: FAQs for structured data/JSON-LD
- `ALL`: All enabled FAQs (default)

```
query {
  products(filter: { sku: { eq: "YOUR-SKU" } }) {
    items {
      faqs(type: PDP) {
        faq_id
        question
        answer
        position
      }
    }
  }
}
```

### FAQ Categories

[](#faq-categories)

Fetch the full FAQ category tree with nested children:

```
query {
  orangecatFaqCategories {
    category_id
    name
    url_key
    faqs { question answer }
    children {
      name
      faqs { question answer }
    }
  }
}
```

> **Store Context**: Include the `Store` HTTP header (e.g., `Store: spain`) to get translations for a specific store view.

For Developers
--------------

[](#for-developers)

### Structured Data

[](#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

[](#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).

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance71

Regular maintenance activity

Popularity8

Limited adoption so far

Community9

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~1 days

Total

4

Last Release

162d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2b0424a2b27fcf1f5c4362f5ab7f4fc78b56dfffe4897c4fd8177623b50fb953?d=identicon)[olivertar](/maintainers/olivertar)

---

Top Contributors

[![olivertar](https://avatars.githubusercontent.com/u/959440?v=4)](https://github.com/olivertar "olivertar (3 commits)")

### Embed Badge

![Health badge](/badges/orangecat-faqs/health.svg)

```
[![Health](https://phpackages.com/badges/orangecat-faqs/health.svg)](https://phpackages.com/packages/orangecat-faqs)
```

###  Alternatives

[fastly/magento2

Fastly CDN Module for Magento 2.4.x

1564.2M1](/packages/fastly-magento2)[mage-os/module-automatic-translation

Automatic AI content translation for Mage-OS.

277.1k](/packages/mage-os-module-automatic-translation)[zepgram/module-rest

Technical module to industrialize API REST call with dependency injection pattern using Guzzle library

1326.2k](/packages/zepgram-module-rest)[graycore/magento2-graphql-introspection-cache

1015.2k](/packages/graycore-magento2-graphql-introspection-cache)[mage-os/mageos-common-async-events

Send REST requests to external endpoints asynchronously. This module implements the most common events like order creation and customer change.

147.7k2](/packages/mage-os-mageos-common-async-events)[mage-os/module-inventory-reservations-grid

Add a grid with the list of inventory reservations.

126.8k](/packages/mage-os-module-inventory-reservations-grid)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)