Skip to content

README.md

Latest commit

 

History

History
63 lines (43 loc) · 3.59 KB

README.md

File metadata and controls

63 lines (43 loc) · 3.59 KB
Raw

ShareSurfer Visual Assets

This folder contains user-facing workflow visuals, current example screenshots of the offline HTML report, and dated standalone dashboard screenshot sets.

The report and standalone dashboard screenshots use synthetic CONTOSO-style demo data. They are meant to show first-time operators and management readers what the dashboard looks like before they run ShareSurfer. They are not live customer evidence or future-design mockups.

Workflow Illustrations

The current workflow illustrations are:

  • share-surfer-workflow-concept.png
  • nonpermissive-collector-workflow.svg
  • dataset-transfer-dashboard-workflow.svg
  • collector-to-report.svg
  • enterprise-lab-validation.svg
  • support-bundle-diagnostics.svg
  • readme-flow-guides/first-scan-owner-review.png
  • readme-flow-guides/ownership-import-reusable-commands.png
  • readme-flow-guides/locked-down-collector-dashboard-host.png
  • readme-flow-guides/migration-discovery-cleanup-planning.png
  • field-guide/evidence-pipeline.png
  • field-guide/share-gate-ntfs-model.png
  • field-guide/identity-org-enrichment.png
  • field-guide/migration-discovery-signals.png
  • field-guide/diagnostics-trust-review.png
  • field-guide/redacted-support-handoff.png

Use nonpermissive-collector-workflow.svg when explaining read-only collection inside a restricted network. Use dataset-transfer-dashboard-workflow.svg when explaining how a validated dataset moves to a separate dashboard review workstation. These diagrams are intentionally text-rich so a first-time operator can understand the steps, gates, and outputs without extra context.

Use the readme-flow-guides/ PNGs when you need a more descriptive one-page visual for first-time readers: first scan to owner review, ownership import with reusable commands, locked-down collector to dashboard host, and migration discovery cleanup planning.

Use the field-guide/ PNGs with the visual field guide when you need a more detailed walkthrough for managers, business reviewers, or first-time operators.

Report Screenshots

The current offline report.html screenshots are:

  • report-dashboard-overview.png
  • report-dashboard-workbench.png
  • report-dashboard-findings.png
  • report-dashboard-migration.png

Refresh them from a trusted docs-maintainer workstation when the dashboard layout changes:

pwsh -NoLogo -NoProfile -File .\scripts\New-ShareSurferDashboardScreenshots.ps1

The script generates a synthetic export under docs\.generated\dashboard-screenshots, builds report.html, and captures the four screenshots with Playwright. Use this dry run when you only want to verify the report generation path without browser capture:

pwsh -NoLogo -NoProfile -File .\scripts\New-ShareSurferDashboardScreenshots.ps1 -SkipBrowserCapture

If Playwright is not available, keep the existing screenshots and rerun the capture from a workstation where the Playwright Node package and browser binaries are installed.

Preserved Dashboard Screenshot Sets

Keep dated standalone dashboard screenshot sets under dashboard-screenshots/ when they are useful for documentation, release notes, or first-run walkthroughs. The current preserved set is:

  • dashboard-screenshots/2026-06-09-current/ - standalone dashboard QA captures for overview, ad-hoc table filtering, findings filters, permissioned group review, path context, sidebar collapse, Migration Discovery selector filtering, and local review decisions.

Use the dated folder in documentation when you need stable screenshots that should not be overwritten by the next automated screenshot refresh.