Repository navigation
docs(recording): document Record Keyword and Record Keywords - #24
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
Control-free looping videos lack an accessible pause mechanism, and several documentation examples use nonmatching selectors or link names that cause timeouts.
4 open issues
controlsis false, these autoplaying, indefinitely repeating videos have no… · Newinput[type="password"]fields, which have no implicittextboxrole.… · NewFinding elements, using the title in… · Newtextboxrole, so this selector will not locate a normal… · New
What changed in this PR
Adds a six-page “Recording keywords” chapter explaining how to use Record Keyword and Record Keywords, supported by video demonstrations and toolbar screenshots.
Changes:
- Documents recording workflows, arguments, supported actions, output files, and practical limits.
- Adds
DocVideo, media-gallery examples, and scripts for reproducing documentation media. - Adds the chapter to both documentation menus and updates the section-order test.
| File | Description |
|---|---|
test/docs-order.spec.ts |
Adds recording to the expected section order. |
scripts/videos/video.resource |
Provides shared recording and interaction helpers. |
scripts/videos/video-helpers.cjs |
Draws the pointer and exposes toolbar access for scripts. |
scripts/videos/render.sh |
Converts recordings into MP4s and poster images. |
scripts/videos/README.md |
Explains how to regenerate documentation media. |
scripts/videos/pages/create-account.html |
Supplies the account-form demonstration page. |
scripts/videos/09-screenshots.robot |
Captures toolbar and argument-dialog screenshots. |
scripts/videos/08-loop-pause.robot |
Records the pause/resume demonstration. |
scripts/videos/06-loop-login.robot |
Records the login demonstration. |
scripts/videos/05-assertions.robot |
Records assertion-tool usage. |
scripts/videos/04-argument-from-a-selector.robot |
Demonstrates parameterizing a selector. |
scripts/videos/03-loop-create-account.robot |
Demonstrates arguments and repeated-value replacement. |
scripts/videos/02-session.robot |
Demonstrates a multi-keyword recording session. |
scripts/videos/01-quick-start.robot |
Records the introductory walkthrough. |
scripts/videos/.gitignore |
Excludes raw recording output. |
content/gallery/media.md |
Shows video and figure component usage. |
content/docs/recording/what-gets-recorded.md |
Explains recorded actions, assertions, and selectors. |
content/docs/recording/toolbar.md |
Documents toolbar controls and session behavior. |
content/docs/recording/record-keywords.md |
Introduces recording with a quick-start guide. |
content/docs/recording/practice.md |
Covers review habits, secrets, limits, and troubleshooting. |
content/docs/recording/files.md |
Explains output destinations and file updates. |
content/docs/recording/arguments.md |
Explains converting recorded values into arguments. |
app/pages/docs/[...slug].vue |
Adds the recording section to the documentation rail. |
app/components/SiteHeader.vue |
Links the chapter from the Docs menu. |
app/components/content/DocVideo.vue |
Adds visibility-triggered video playback and reduced-motion handling. |
Review effort: Balanced
Contributor
Previewhttps://rfbrowser-pr-24.surge.sh
Rebuilt on every push to this branch, and taken down when it closes. |
Snooz82
force-pushed
the
docs/recording-keywords
branch
from
November 1, 2026 18:52
84164b1 to
4343a14
Compare
A new chapter "Recording keywords" with six pages: getting started, the toolbar, keyword arguments, what gets recorded, where keywords are written, and good practice and limits. Short looping videos and toolbar screenshots show the recorder at work; the Robot scripts that record them live in scripts/videos. - DocVideo: a muted video that plays while visible, optionally without controls for loops. - The chapter is listed in the docs rail and the header Docs menu.
A new page in the Recording keywords chapter: picking with a click, the Playwright and CSS generators, editing with the live match count, and how the keyword ends. With a loop video and a screenshot of the toolbar.
label= finds an element by its label, as Playwright's getByLabel, with the same value forms as text=. A leading >>> searches every frame. Both come with the Browser library branch feature/any-frame-selector.
pnpm 12.16, nuxt 4.6, @nuxt/content 3.16, vue-router 5.4, vitest 5 and playwright-core 1.64, with Node pinned in .nvmrc. The reachable client JS ceiling goes to 420 KB: per page the update is lighter.
On a client-side navigation unhead calls the head function during setup, and reading rendered above its declaration threw.
…dings Picking a selector while recording: the Pick button, Playwright's Pick locator opening the same panel, the comment row it writes, and what the minimized toolbar offers meanwhile. Record Selector's highlight switch. All videos and toolbar screenshots recorded again with the current toolbar.
…a toolbar - What gets recorded: the recorder switches to the tab an action happens in, with the id the previous Switch Page returned, and closes a tab that is not the active one by its id. A tab without an id gets no switch. - Toolbar: Record Keyword has Save, which ends the session; Pick works in the tab it is pressed in; nothing done in the toolbar is recorded. - Limits: tabs without an id, and the pages that show no toolbar. - The argument example opens "Finding elements", the chapter's link text.
Snooz82
force-pushed
the
docs/recording-keywords
branch
from
November 1, 2026 19:05
4343a14 to
c3bde31
Compare
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.
A new chapter "Recording keywords" with six pages: getting started, the toolbar, keyword arguments, what gets recorded, where keywords are written, and good practice and limits. Short looping videos and toolbar screenshots show the recorder at work; the Robot scripts that record them live in scripts/videos.