Add a user-guide screenshot
Add a screenshot when a user page must show the reader a screen of the web app. The documentation guide gives the rules for the images.
Before you start
Install the repository dependencies, as Local verification describes.
Add the screenshot
- Add the screen to the list in
webapp/e2e/screenshots/user-guide.shot.ts. - Add the data for the screen to
webapp/e2e/screenshots/workspace.ts. Use invented names. Use practice names from the shipped catalog. - Run
vp run generate:docs-screenshots. - Look at the light and the dark image.
- Add the
Screenshotcomponent to the page with itssrc. Give it analttext that says what the image shows, in at most 155 characters.
Check that it worked
vp run generate:docs-screenshotsends with no failed screen.vp run gate:docs-pagesends with no error.vp run docs:devshows the image of each color scheme on the page.