Skip to content

Guide

A guide is a piece of help content — a cover picture, a short description and a downloadable file — listed on the support page.

Guides give clients self-service material without needing a support request. Each row pairs descriptive text with an Attachment holding the document itself, plus an optional cover image. status and order control whether a guide is published and where it sits in the list.

Guides are authored by staff and rendered read-only for clients.

  • app/Services/SupportDataService.php — loads published guides with picture and file eager-loaded, cached.
  • app/Http/Controllers/SupportController.php — renders the support Inertia page from that service.
  • app/Filament/Resources/GuideResource.php — staff create and order guides here.
Relation Type Related model
picture belongsTo Attachment via picture_id
file belongsTo Attachment via file_id

Table: guides.

Column Type Notes
id uuid Primary key
title string
description text
picture_id uuid Nullable FK to attachments, null on delete
file_id uuid Nullable FK to attachments, null on delete
status string Defaults to published
order integer Cast to integer, defaults to 0
created_at, updated_at timestamp

Guides are not scoped to an organisation — they are global content.