Skip to content

@W-22799934: Onboarding walkthrough#466

Open
amit-kumar8-sf wants to merge 5 commits into
developfrom
subfeature-W-22358145-Onboarding-walkthrough
Open

@W-22799934: Onboarding walkthrough#466
amit-kumar8-sf wants to merge 5 commits into
developfrom
subfeature-W-22358145-Onboarding-walkthrough

Conversation

@amit-kumar8-sf
Copy link
Copy Markdown
Collaborator

@amit-kumar8-sf amit-kumar8-sf commented Jun 2, 2026

Summary

Adds a guided onboarding experience to the B2C DX VS Code extension. Replaces the static walkthrough
with a persona-driven Onboarding Panel (Storefront, API/Integration, DevOps/Release, AI-augmented)
that walks new developers through CLI install, dw.json setup, OAuth/WebDAV/SCAPI credentials,
sandbox connect, cartridge deploy, and Code Sync — each step targeting the active config in
dw.json rather than the last entry. Also bundles one-click installers for B2C agent skills + MCP
across Claude Code, Cursor, Copilot, Windsurf, Codex, and OpenCode.

Key changes:

  • New src/walkthrough/ module: onboarding panel, persona/step catalog, scoped per-step setup
    commands (b2c-dx.setup.connection|oauth|webdav|scapi), inspect/validate/accessibility helpers, and
    step-detection utilities.
  • Deploy banner now uses a tagged result (ok | no-provider | no-instance | no-code-version | error) with WebDAV PROPFIND fallback when OCAPI lacks permissions — no more generic "OAuth not
    configured or instance unreachable" message.
  • SCAPI step writes oauth-scopes as a JSON array (was breaking AM token requests when stored as a
    space-separated string) and warns that pinning shopper-* scopes can break Sandbox Explorer if the AM
    client isn't registered for them.
  • Setup wizards resolve the active dw.json config via readActiveInstanceName /
    ensureActiveInstanceName, so OAuth/WebDAV/SCAPI updates land on the active entry, not the last
    one.
  • Test workspace and walkthrough markdown content under media/walkthrough/.

Testing

  • Manual end-to-end run of each persona flow (Storefront, API/Integration, DevOps, AI-augmented)
    against a real sandbox:
    • Verified per-step setup commands write to the active dw.json config and refresh the Resolved
      Config inspector correctly.
    • Verified the Deploy banner's "Deployed" row now shows specific reasons (no instance / no
      code-version / actual error) and falls back to WebDAV when OCAPI returns 403.
    • Verified oauth-scopes is written as string[] and Realm Explorer / Sandbox Explorer load with
      the resulting config.
    • Verified the AI-skills step installs MCP + agent skills for the supported IDEs.
  • pnpm run typecheck:agent and pnpm run lint:agent clean in packages/b2c-vs-extension.
  • Existing src/walkthrough/test/commands.test.ts Mocha suite passes via pnpm --filter b2c-vs-extension test.

Dependencies

  • No net-new third-party dependencies were added
  • If net-new third-party dependencies were added, rationale/discussion is included and
    3pl-approved is set by a maintainer

  • Tests pass (pnpm test)
  • Code is formatted (pnpm run format)

@W-22210602

Adds a 5-phase getting-started walkthrough that guides users through CLI
install, dw.json setup, OAuth/Basic auth, cartridge deploy, and scaffold
generation. Includes a role-based onboarding panel with persona-specific
paths (Storefront, API/Integration, DevOps, AI-augmented).

Resolved Config inspect panel:
- Mask secrets as a lock pill instead of first-4 preview
- Stats strip with field/source/secret counts
- Source-tinted pills, zebra-striped table, accent-bordered group cards

Scaffold:
- Always generate cartridges into <workspace>/cartridges so the
  Cartridges view picks them up without dw.json configuration
- Explicit Cartridges-view refresh after .project creation, since the
  **/.project FileSystemWatcher can race scaffold writes
@amit-kumar8-sf amit-kumar8-sf marked this pull request as ready for review June 3, 2026 03:40
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.

1 participant