You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
As a first-time user, I want a single VS Code walkthrough (contributes.walkthroughs) that takes
me from a freshly-installed extension to my first exported Wardley Map, following the official walkthrough UX guidelines.
Motivation
The extension contributes no walkthrough, so after install there is no in-editor onboarding: a
new user must already know the file extensions, the two custom editors, and the canvas toolbar. A
focused walkthrough on VS Code's Get Started page shortens time-to-first-map and teaches the
graphical ↔ OWM-DSL round-trip and export. Per the guidelines, this should be one walkthrough
with a small number of steps, each with a verb action button and theme-aware SVG media.
Proposed Solution
Add one walkthrough — id: wardley.gettingStarted, title "Get Started with Wardley Maps" —
with 3 focused steps. Each step has a single verb action button, theme-aware SVG media
(apps/vscode/media/walkthroughs/*.svg, using VS Code Theme Colors so it renders in light & dark,
with altText), and a realistic completionEvents:
Summary
As a first-time user, I want a single VS Code walkthrough (
contributes.walkthroughs) that takesme from a freshly-installed extension to my first exported Wardley Map, following the
official walkthrough UX guidelines.
Motivation
The extension contributes no walkthrough, so after install there is no in-editor onboarding: a
new user must already know the file extensions, the two custom editors, and the canvas toolbar. A
focused walkthrough on VS Code's Get Started page shortens time-to-first-map and teaches the
graphical ↔ OWM-DSL round-trip and export. Per the guidelines, this should be one walkthrough
with a small number of steps, each with a verb action button and theme-aware SVG media.
Proposed Solution
Add one walkthrough —
id: wardley.gettingStarted, title "Get Started with Wardley Maps" —with 3 focused steps. Each step has a single verb action button, theme-aware SVG media
(
apps/vscode/media/walkthroughs/*.svg, using VS Code Theme Colors so it renders in light & dark,with
altText), and a realisticcompletionEvents:[Create Example Map](command:wardley.newMapFromExample)(opens the Tea Shop example — an idealfirst artifact).
completionEvents: ["onCommand:wardley.newMapFromExample"].→ Dependency: this is the "create a model" command from Issue A ([Feat]: As a VS Code user, I want the extension's core operations in the Command Palette so that I can create and export maps without digging through menus #63). It already exists today
(
wardley.newMapFromExample), so the step is not blocked; Issue A ([Feat]: As a VS Code user, I want the extension's core operations in the Command Palette so that I can create and export maps without digging through menus #63) canonicalizes itscategory/title.
[Browse Wardley Commands](command:workbench.action.quickOpen?%5B%22%3EWardley%20%22%5D)prefillsthe palette with
>Wardleyto reveal the command surface from Issue A ([Feat]: As a VS Code user, I want the extension's core operations in the Command Palette so that I can create and export maps without digging through menus #63).completionEvents: ["onCommand:workbench.action.quickOpen"].[Export as SVG](command:wardley.exportSvg)to export the map forsharing/embedding.
completionEvents: ["onCommand:wardley.exportSvg"].→ Dependency: requires the new
wardley.exportSvgcommand from Issue A ([Feat]: As a VS Code user, I want the extension's core operations in the Command Palette so that I can create and export maps without digging through menus #63) → this step isblocked by Issue A ([Feat]: As a VS Code user, I want the extension's core operations in the Command Palette so that I can create and export maps without digging through menus #63).
Acceptance Criteria
contributes.walkthroughs, idwardley.gettingStarted) is shownon the Get Started page after install.
altText(render correctly in light and dark themes).completionEventscheck off each step when its action runs (onCommand:…).wardley.newMapFromExample) from Issue A ([Feat]: As a VS Code user, I want the extension's core operations in the Command Palette so that I can create and export maps without digging through menus #63)'s shared category.wardley.exportSvg(depends on Issue A ([Feat]: As a VS Code user, I want the extension's core operations in the Command Palette so that I can create and export maps without digging through menus #63)).npm run lint,npm test, andnpm run typecheckstay green.Alternatives Considered
multiple walkthroughs unless absolutely necessary".
walkthrough is the native onboarding surface.
Note: uses
enhancement+documentation(the repo's docs label); no workspace/scope label exists.