Skip to content

Commit 5436fb3

Browse files
committed
update genereal description in readme
1 parent 15271e7 commit 5436fb3

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

web/src/shared/video-tutorials/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,30 @@
11
# Video Tutorials
22

33
The video tutorials module displays YouTube video tutorials inside the
4-
authenticated app shell. A floating "Video tutorials" button appears in the
5-
bottom-right corner. Clicking it opens a two-panel modal: the left panel shows
4+
authenticated app shell.
5+
6+
The configuration for the module (list of videos for specific app version) is fetched
7+
as static JSON from 'https://pkgs.defguard.net/api/content/video-tutorials.
8+
9+
A launcher button (`NavTutorialsButton`) is shown in the
10+
navigation bar if the JSON config is successfully fetched and parsed.
11+
Clicking it opens a two-panel modal: the left panel shows
612
a searchable, collapsible list of all tutorial sections; the right panel shows
713
the selected video in an embedded YouTube player with its title, description,
814
and links to the relevant app page and documentation.
915

16+
A separate floating "Video support" button appears in the
17+
bottom-right corner when at least one video is available for the current route.
18+
Clicking it opens a floating list of video cards with thumbnails and titles.
19+
Clicking on a specific card opens a modal with an embedded YouTube player.
20+
1021
The module is mounted in `src/routes/_authorized/_default.tsx` and is therefore
11-
available across the entire authenticated layout. While a video is loading a
22+
available across the entire authenticated layout.
23+
24+
While a video is loading a
1225
skeleton placeholder is shown; if the video fails to load within 8 seconds, a
13-
"Video unavailable" message is displayed instead.
26+
"Video unavailable" message is displayed instead with a clickable YouTube link.
1427

15-
A separate floating launcher button (`NavTutorialsButton`) is shown in the
16-
navigation when at least one video is available for the current route. Clicking
17-
it also opens the modal.
1828

1929
---
2030

0 commit comments

Comments
 (0)