Step-aware wizard video tutorial section#2749
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the web video tutorial “wizard sidebar” feature to support step-specific guides and extends it to the initial setup and auto-adoption wizards, backed by a lightweight /api/v1/version endpoint in the setup/migration webapps.
Changes:
- Introduce step-aware wizard placements (
default+steps) in the video tutorials mapping/types/schema and update resolver logic accordingly. - Add wizard video guide placement keys for initial setup and auto-adoption flows; pass the active step key into placement resolution.
- Add
/api/v1/versionendpoint indefguard_setupand a corresponding frontend query option.
Reviewed changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| web/tests/video-tutorials.test.ts | Updates/extends tests for step-aware placement resolution and parsing. |
| web/src/shared/video-tutorials/types.ts | Changes placements type to VideoGuidePlacementGroup (default + steps). |
| web/src/shared/video-tutorials/resolver.ts | Adds step-aware placement resolution logic. |
| web/src/shared/video-tutorials/resolved.tsx | Uses /version query for wizard placement resolution. |
| web/src/shared/video-tutorials/data.ts | Updates Zod schema to parse step-aware placement groups. |
| web/src/shared/video-tutorials/README.md | Documents new placement structure, keys, and fallback order. |
| web/src/shared/query.ts | Adds getVersionQueryOptions. |
| web/src/shared/components/wizard/WizardVideoGuide/WizardVideoGuide.tsx | Adds spacing in the wizard video guide UI. |
| web/src/shared/components/wizard/WizardPage/WizardPage.tsx | Passes active step ID to placement resolution hook. |
| web/src/shared/api/types.ts | Adds VersionResponse type. |
| web/src/shared/api/api.ts | Adds api.app.version() and removes unused top-level info. |
| web/src/routes/_wizard/migration/index.tsx | Removes AppInfo/AppUser providers wrapper for migration wizard route. |
| web/src/pages/SetupPage/initial/SetupPage.tsx | Sets videoGuidePlacementKey="initialSetupWizard". |
| web/src/pages/SetupPage/autoAdoption/AutoAdoptionSetupPage.tsx | Sets videoGuidePlacementKey="autoAdoptionWizard". |
| crates/defguard_setup/src/setup_server.rs | Adds /api/v1/version route. |
| crates/defguard_setup/src/migration.rs | Adds /api/v1/version route and removes /info + /me routes. |
| crates/defguard_setup/src/handlers/version.rs | Implements GET /version handler returning { version }. |
| crates/defguard_setup/src/handlers/mod.rs | Exposes the new version handler module. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
moubctez
previously approved these changes
Apr 20, 2026
- video and docs are optional - multiple documentation links
moubctez
approved these changes
Apr 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1866.