Skip to content

Tutorials Configuration Documentation

Jump to bottom
TrumanBlurbank edited this page Jun 16, 2025 · 1 revision

This documentation provides an overview of the tutorial entries defined in the YAML structure. Each tutorial is a guide that may include videos, step-by-step content, images, and links.

Tutorials are located at db/yaml/<locale>/tutorials.<locale>.yml.

🔑 Global Structure

Each tutorial entry in the YAML is an object with the following keys:

Key Type Description
title string The title of the tutorial displayed to users.
identifier string Unique identifier (slug-like) for internal linking or reference.
level integer Represents the difficulty or depth (0 = beginner, 1 = intermediate, 2 = advanced).
content array Ordered list of tutorial steps, figures, messages, or sections.
time integer Estimated completion time in minutes (Optional).
created_at string ISO 8601 date string when the tutorial was created (Optional).
highlight boolean Whether this tutorial should be spotlight on tutorials page (Optional).
banner string Banner image identifier to be used for theming (Optional).
short_description string A short optional summary of the tutorial's goal (Optional, used for SEO).
author string Name of the author (Optional).
figure object Main media block (usually a video) representing the tutorial (Optional).
useful_links array List of relevant external URLs or resources (Optional).

📄 Field Descriptions

content Array Elements

Each content entry may contain the following:

Key Type Description
mode string A visual hint (e.g. success, warning, info) to signal the importance or type of message.
body array<string> Paragraphs or instructional content (text or HTML).
figure array Images with captions, illustrating steps.
render object Special directive for rendering templates or partials (used for embedded features).

figure.video

Key Type Description
url string Video embed URL (YouTube iframe link recommended).
title string Video title shown alongside the embed.
created_at string Date the video was added.

figure.image

Used inside content.figure:

Key Type Description
image string Relative path to the image file.
caption string Caption shown below the image (Optional).

🔗 useful_links

A list of links associated with the tutorial. Each entry can include:

Key Type Description
url string The URL of the external resource.
description string A brief description of the link's purpose (Optional).

📌 Notes

  • Tutorials can be added or removed without affecting the rendering system as long as they follow this schema.
  • YAML must be correctly indented; all figure, content, and video sub-objects require proper nesting.
  • render is used to include complex content hard to specify in YAML.

Clone this wiki locally