Letscms FAQs Module Documentation

Introduction

  • The Letscms FAQ module is designed to help Magento 2 store owners manage and display Frequently Asked Questions (FAQs) in an organized and user-friendly manner. This module offers a wide range of features that streamline the FAQ management process, such as the ability to enable or disable FAQs, group FAQs into categories, display FAQs via shortcodes, and ensure responsiveness across devices.

Installation

Preparation:

  • Before starting the installation, ensure that your Magento environment meets the following prerequisites:
System Requirements:
  • PHP Version: 7.4 or higher is recommended.
  • Composer: Must be installed for dependency management.
  • Database Backup: Backup your database and files to prevent data loss during installation..

Magento 2 module installation. Here's a detailed guide on how to proceed:

Magento 2 module Installation

Step 1:Extract the Zip File:
  • Extract the contents of the zip file to a temporary directory on your computer.
Step 2: Copy Files to Magento Root Directory:
  • Copy all files and folders from the extracted zip file.
  • Paste the copied files into the Upload the extracted files to the app/code/Letscms/Faq directory in your Magento root.
Step 3: Open Terminal or CMD:
  • Change your working directory to the Magento root directory using the following command:
  • you need to run the following commands to install and activate the module:

    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy -f
    php bin/magento cache:clean

Verify Installation:

  • php bin/magento module:status
  • Log in to the Magento admin panel and check if the Letscms > FAQs menu is visible under the admin sidebar.

Troubleshooting:

  • FAQs are not displaying Ensure that the FAQs are enabled and assigned to a group. Check the group-specific shortcode placement on the page.
  • FAQs are not responsive Verify that your theme is compatible with responsive designs or check for conflicts with custom styles.
  • Magento Cache: If you encounter issues, try clearing Magento caches and reindexing:

    php bin/magento indexer:reindex
    php bin/magento cache:clean

Configuration


General Settings

genralconfig Letscms FAQ page

The Letscms FAQ module is easy to configure. You can manage FAQ categories (groups) and individual FAQ entries from the admin panel.

  • Go to Stores > Configuration > Letscms > FAQ . to configure general settings for the FAQ module:
  • Fill all given fields
  • Enable FAQ: set "YES" to enable for website.


  • Key Features and Usage

    Enabling and Disabling FAQs:

    This feature allows store administrators to control which FAQs are visible to customers. FAQs can be enabled or disabled without being deleted.

    • Go to Letscms FAQ > FAQs Listingin the admin panel.
    • Show FAQ listAdd New FAQ
    • In theStatusfield, chooseEnabled or Disabled.
    • Click Save.

    Creating FAQ Groups

    genralconfig Letscms FAQs page

    The Letscms FAQ module is easy to configure. You can manage FAQ categories (groups) and individual FAQ entries from the admin panel.

  • Go to Letscms FAQ > FAQ Groups Listing
  • Click Add New Groupto create a new group.
  • Enter a name for the group and Fill all given fields
  • Creating FAQ

    genralconfig Letscms FAQ page
  • Go to Letscms FAQ > FAQ Listing
  • Click Add New FAQto create a new FAQ.
  • Enter a name for the FAQ Title and Fill all given fields
  • Remove FAQ

    Remove individual FAQs or entire FAQ groups

  • Go to Letscms FAQ > FAQ Listing
  • Click deletedOn FAQ Table Row
  • Mass Action Delete FAQ

    The Mass Action Delete feature allows administrators to delete multiple FAQ items at once from the Letscms Faq modul

  • Go to Letscms FAQ > FAQ Listing
  • Click In the FAQ listing, you will see a checkbox next to each FAQ item.
  • FAQ Shortcode:

    • In a CMS page or block, insert the following shortcode:
    •  {{block class="Letscms\Faq\Block\Index\Index" template="Letscms_Faq::faq_main.phtml" group_id=XX }}
    • Replace XX with the ID of the FAQ group to display.
    • Save the page or block.

    Use Cases:

  • Display FAQs related to specific products or services on relevant pages.
  • Uninstallation Guide


    To remove the module, run the following commands:

  • you need to run the following commands to install and activate the module:

    php bin/magento module:disable Letscms_Faq
    php bin/magento setup:upgrade
    php bin/magento setup:di:compile
    php bin/magento setup:static-content:deploy -f
    php bin/magento cache:flush
  • Image 1
    Image 2
    Image 3
    Image 4