Skip to content

docs(pro): document in-app walkthroughs and the App Tour - #16261

Merged
blakeaowens merged 3 commits into
devfrom
docs/in-app-walkthroughs
Oct 15, 2026
Merged

blakeaowens merged 3 commits into
devfrom
docs/in-app-walkthroughs

Conversation

@blakeaowens

@blakeaowens blakeaowens commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Description

Adds a documentation page for In-App Walkthroughs, a new DefectDojo Pro beta feature (feature flag walkthroughs, on by default).

The page covers:

  • What a walkthrough is: each step outlines one area of the page, dims the rest, and only the outlined area and the step card respond to clicks. Some steps advance on Next, others when the user does the real thing.
  • The lightbulb in the lower right corner, which lists the walkthroughs for the current page (This Page) and the ones available anywhere (General), with Take the Tour, Resume Tour, Retake the Tour and Restart.
  • The Learn more link on each step card, which opens the matching section of these docs in a new tab.
  • The App Tour: Home, the sidebar, the asset list, one asset, its findings and one finding, including what happens when the user opens a different record or navigates away.
  • How the App Tour behaves with nothing to open: it skips the steps that open a record, and when the sandbox is turned on its first and last steps point at the sandbox, where an Open the Sandbox button starts the tour again on sample data.
  • The first-visit offer on Home (Start, Not Now, Don't Ask Again).
  • The two per-user switches on the User Profile page: Offer Walkthroughs Automatically and Show the Walkthrough Lightbulb.
  • Turning the feature off instance-wide under Settings > Feature Flags.
  • What is stored per user.

The feature's Feature Flags entry links to this page, so it should merge together with the matching Pro change.

Docs only, no code changes.

Add an In-App Walkthroughs page: the lightbulb launcher, the App Tour,
Resume and Restart, the Learn more links, the first-visit offer, the
per-user switches on the User Profile page, and what is stored.
@blakeaowens
blakeaowens requested a review from Maffooch as a code owner October 7, 2026 18:52
@blakeaowens blakeaowens added this to the 3.4.100 milestone Oct 7, 2026
@github-actions github-actions Bot added the docs label Oct 7, 2026
…ata tour

The lightbulb lists only walkthroughs for features the user can use,
All Walkthroughs lists every one in a table, the App Tour runs without
data, a missing step offers Try Again and Skip, and the tour steps
aside for a dialog opened during a step.
@blakeaowens blakeaowens modified the milestones: 3.4.100, 3.4.200 Oct 12, 2026
@blakeaowens
blakeaowens added this pull request to the merge queue Oct 12, 2026
@blakeaowens
blakeaowens removed this pull request from the merge queue due to a manual request Oct 12, 2026
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@blakeaowens
blakeaowens added this pull request to the merge queue Oct 15, 2026
Merged via the queue into dev with commit ec597af Oct 15, 2026
32 checks passed
@blakeaowens
blakeaowens deleted the docs/in-app-walkthroughs branch October 15, 2026 05:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants