Skip to content

docs: Copilot feature walkthroughs - #6668

Merged
emarc merged 20 commits into
mainfrom
docs/copilot-walkthroughs
Nov 16, 2026
Merged

emarc merged 20 commits into
mainfrom
docs/copilot-walkthroughs

Conversation

@emarc

@emarc emarc commented Nov 13, 2026

Copy link
Copy Markdown
Contributor

Adds a Features section under Tools › Copilot: one page per feature, ordered from basic to advanced, each with a short step-through walkthrough recorded from a real app, in light and dark.

  • One page per feature, so Copilot can link to it directly (with UTM tags) and the stats show interest per feature.
  • Existing pages and anchors are unchanged.
  • The clips have no text on them: the words are in the page, so they can be edited and translated without re-recording. The clips are scripted, so they can be re-recorded when Copilot changes.
  • New: walkthroughs for the toolbar, the ⋮ menu (App Info, Logs & Settings), selecting, Go to Source, Inspect mode, editing text, properties, spacing and alignment, the UI library, drag and drop, copy and paste, wrapping with a layout, prompting the AI, listeners, views and routes, impersonating users, component classes, and the accessibility checker.

Depends on the walkthrough player PR (this PR's base branch).

Note on size: the clips are committed to the repo (242 files: mp4, poster jpg, gif; about 38 MB). If they should be hosted elsewhere, let's decide here.

🤖 Generated with Claude Code

https://claude.ai/code/session_01Rq75h4rxBUs4mABwUwqNuJ

emarc added 15 commits November 13, 2026 10:02
A [.walkthrough] ordered list, one step per item with a short looping clip
or a still, becomes a stepper: one step at a time with Back and Next, the
arrow keys, and Show all steps for the list. Clips have a -dark twin that
is shown in the dark theme. Without the script the list reads as is.
A [.walkthrough] block without a list is a single clip, for a page that
has a section for each. It gets the same Pause button and dark-theme
twin as the steps, and plays only while it's in view. The frame around
a walkthrough is now only for the stepped ones.
Edit Text in Place, Move Components with Drag & Drop and Go to Source,
each a short page that opens with a step-by-step walkthrough: a short
clip per step, recorded from Copilot in a new start.vaadin.com project,
in light and dark. The walkthroughs are generated (the _walkthrough-*
partials and their clips); the pages around them are written by hand.
The Copilot page links to the new pages from its Context Menu and Drag
& Drop sections and is otherwise unchanged.
The new walkthrough pages come first, then Internationalization and Figma
to Code. Only the navigation order changes; no URL does.
Where the toolbar is, its modes, and its menu, as the first page under
Copilot. The Basic Operation section links to it.
What the menu shows at the top, and what App Info, App Log, Features,
Feedback, and Settings open. The Vaadin Copilot UI section links to it.
The toolbar walkthrough's menu step now lists the items the menu has.
…u item

The new pages are under Copilot > Features (tools/copilot/features/),
from basic to advanced. They haven't been published, so no URL changes.

The Copilot Menu page has a section for each item, each with its own
clip from the closed menu to the panel it opens, instead of one
walkthrough that steps through them all.
Select Components, Change Properties, Spacing & Alignment, Add
Components from the UI Library, Copy, Paste, Duplicate & Delete, Wrap
Components with a Layout, and Edit Inside a Component Class, under
Copilot > Features, ordered basic to advanced with the others. The
Copilot page links to them where it mentions the feature.
Find your way around (toolbar, select, Go to Source), change what's
there, change the structure, then component classes. The menu, a
reference for its panels, goes last. Only the navigation order
changes.
…and accessibility

Ask AI About the Selection (three examples: an icon on every field, a
field's format, a form in sections), Inspect Mode, Add Listeners, Views
& Routes, and Check Accessibility, under Copilot > Features. A one-step
walkthrough is a clip with its text, not a list of one. The Copilot
page links to each where it mentions the feature.
@cla-assistant

cla-assistant Bot commented Nov 13, 2026 •

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@cla-assistant

cla-assistant Bot commented Nov 13, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@emarc
emarc force-pushed the feat/copilot-walkthrough-stepper branch from 66a35b6 to 6eea308 Compare November 13, 2026 08:21
@emarc
emarc force-pushed the docs/copilot-walkthroughs branch from 5637f8a to 1cbfc21 Compare November 13, 2026 08:21
@github-actions

github-actions Bot commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Preview Deployment

This PR has been deployed for preview.

URL: https://docs-preview-pr-6668.fly.dev

Changed pages

Added content is highlighted in green; removed content is marked in red on each page.

Built from b5b65bf

peholmst added a commit that referenced this pull request Nov 13, 2026
## What

`Dockerfile.preview` now copies `src/main/resources/META-INF/resources`
into the static site that the preview serves. The site is copied after
them, so the site's own files win if a path clashes.

## Why

In production and in the dev server, these resources come from the
Spring Boot docs app: requests under `/vaadin/` go to it. Preview
deployments serve only the static DSP output with `serve` and don't run
that app, so every `/vaadin/*` path returns 404. For example, on the
preview of #6668:

| Path | Preview | vaadin.com |
|---|---|---|
| `/vaadin/tutorial/schema.sql` | 404 | 200 |
| `/vaadin/videos/aura-theme-editor-teaser.webm` | 404 | 200 |

That breaks the SQL downloads in the tutorial's setup step and the video
on the Aura theme page in every preview.

The preview is served from the site root, so the copied files land at
the same paths the articles link to.

## Testing

- A minimal Docker build that runs only these two `COPY` lines put the
files at `vaadin/tutorial/*.sql`, `vaadin/videos/*.webm` and `icons/*`,
and a clashing file from the site overrode the resource.
- The full preview build wasn't run locally, as it needs the Pro key.
This PR's own preview deployment is the end-to-end check:
`/vaadin/tutorial/schema.sql` on it should return 200.

Labeled `target/v25.3` because the release branch has the same
`Dockerfile.preview`, so previews of PRs to `v25.3` have the same 404s.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
@emarc
emarc marked this pull request as ready for review November 13, 2026 14:04
…ads, and respect reduced motion

- Once the first clip can play, load the rest (they're small), instead of only the next one, so Next doesn't wait. A clip that should play but is still loading shows a spinner, after a moment, instead of its poster, which looks like a finished step.
- Pause the clips when setting them up: the browser may have started autoplaying one already, and it kept looping for a reader who asked for reduced motion.
- Style a single clip that carries [.walkthrough] on the video:: macro itself, where the role lands on the videoblock.
Base automatically changed from feat/copilot-walkthrough-stepper to main November 16, 2026 15:04
@emarc
emarc merged commit ebccc3e into main Nov 16, 2026
11 checks passed
@emarc
emarc deleted the docs/copilot-walkthroughs branch November 16, 2026 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants