Skip to main content

FAQs

In the JetShip Next.js SaaS Starter Kit, the FAQ (Frequently Asked Questions) section allows admins and users with appropriate permissions to create, categorize, and manage FAQs. These FAQs are then displayed on the front end, helping end-users quickly find answers to common questions.

This documentation explains how to manage FAQs and FAQ categories, as well as how these resources are presented to users on the front end.

Storage

FAQs and categories are stored in the database for efficient querying and real-time updates.

🛠 FAQ Categories and FAQs​

Admins and users with the required permissions can easily manage FAQs and categories. The FAQ management tools are split into:

  • FAQ Categories – Organize FAQs into categories to streamline navigation.
  • FAQs – Create and manage individual FAQ entries, including titles, descriptions, and category assignments.

These tools enable admins and authorized users to make changes that will appear on the front-end FAQ page for users.

🔑 Accessing FAQs​

To manage FAQs, follow these steps based on your user role:

  1. Admin: Navigate to the FAQs section in the admin panel.
  2. Authorized User: If you have the required permissions (create_faqs, update_faqs, view_faqs), you can access FAQ management through the user interface.

In the FAQs section, you’ll find two main options to manage:

  • Category: Used to create, edit, and organize FAQ categories.
  • FAQ: Used to create, edit, and manage individual FAQ entries.

📂 Managing FAQ Categories​

Categories help organize FAQs by topic, allowing users to easily navigate and find relevant information. Here’s how to manage categories:

Creating a New Category​

  1. Go to FAQs > Categories in the admin panel or user interface (if you have the necessary permissions).
  2. Click on the Add New Category button.

In the Create FAQ Category form, fill in the following fields:

  • Category Name (required): Choose a descriptive name for the category (e.g., "Getting Started", "Technical Details").
  • Table Icon (required): Select a Tabler icon to visually represent the category (e.g., "TbStar", "TbSearch").

Once you’ve filled in the details, click Create to save the category, or Create & Create Another to immediately add a new category.

tip

Use clear and straightforward category names to make it easier for users to find the information they need on the front end.

📋 Managing Individual FAQs​

This section is where you create and manage individual FAQ entries. Each FAQ can be linked to a category and optionally marked as featured.

Creating a New FAQ​

  1. Go to FAQs > FAQ in the admin panel or user interface (if you have the necessary permissions).
  2. Click on the Add New FAQ button.

In the Create FAQ form, fill in the following fields:

  • Title (required): Enter the FAQ question or topic.
  • Description (required): Provide the answer or explanation. You can format the content, add links, images, and more.
  • Category (required): Assign the FAQ to a category for better navigation.
  • Is Featured (optional): Toggle this option to mark the FAQ as featured for prioritization on the front end.

Once you’ve filled out the details, click Create to save the FAQ, or Create & Create Another to continue adding FAQs.

info

Keep FAQ answers clear, concise, and informative to enhance user experience on the front end.

🌟 Marking FAQs as Featured​

Marking an FAQ as Featured prioritizes it on the front end, making it more visible to users. This is useful for highlighting essential or frequently asked questions. Featured FAQs may appear in prominent positions such as the homepage, dedicated reviews/testimonials page, or product/service pages.

🔍 FAQs on the Front-end Component​

On the front end, users can view FAQs categorized by topics. The front-end FAQ page pulls data dynamically from the database, presenting FAQs based on categories and their featured status. Users can:

  • Browse by Category: FAQs are grouped by categories, enabling users to easily find relevant information.
  • View Featured FAQs: Featured FAQs are highlighted and may appear at the top of the FAQ list or in a dedicated section.
  • Search FAQs: Users can search for FAQs by title or description for quicker answers.
tip

Encourage users to browse categories or check the featured FAQs for commonly asked questions to find answers faster.

🔄 Updating Front-end FAQ Content​

Once updates are made in the admin panel or by authorized users, changes are automatically reflected on the front end. No additional steps are needed to sync the content. Once saved, users will immediately see the most current FAQ information on the front-end FAQ page.