Skip to content

Course Overview

What It Is

The Course Overview is a freeform rich-text narrative field (overview) on the perfxcel.courses table. It is separate from the structured description field and is intended for longer marketing copy — course highlights, key takeaways, or a detailed programme summary.

Where It Appears

On the public course detail page, the Overview section renders between the description paragraph and the Objectives / Target Audience grid, giving visitors a rich narrative before the structured information.

The section is hidden when overview is null or empty.

Authoring in the Course Editor

In the Course Editor (perfxcel-admin), the Overview field uses a rich-text editor (react-quill) with a full formatting toolbar. This allows admins to:

  • Bold and italicise text
  • Add bulleted and numbered lists
  • Insert headings for structure
  • Paste formatted content directly from Word, Notion, or Google Docs — the editor preserves the structure automatically

The field stores output as HTML. A character count (/5000) is shown below the editor.

Public Rendering

The HTML is rendered on the public site using React's dangerouslySetInnerHTML within a prose prose-lg container, ensuring consistent typography with the rest of the page.

Safe HTML

The overview HTML is authored exclusively by authenticated admins inside the admin portal. It is never user-submitted content. There is no user-facing input that writes to this field.

API

The overview field is included in:

  • GET /api/v1/courses/:id — in the course response object
  • POST /api/v1/courses and PUT /api/v1/courses/:id — accepted in the request body

It accepts any string up to 5000 characters (validated by Zod on the backend).