Dataface Tasks

Launch docs and external readiness

IDM3_PUBLIC_LAUNCH-IDE_EXTENSION-02
Statusnot_started
Priorityp0
Milestonem3-public-launch
Ownerui-design-frontend-dev

Problem

External users who install the Dataface extension from the marketplace will have no documentation explaining how to set it up, connect to a dbt project, author dashboards, or interpret diagnostic messages. The existing internal runbooks assume FT Analytics conventions and skip foundational setup steps. Without executable getting-started guides, example dashboards, and reference documentation for diagnostics and preview behavior, new users will fail at installation or first use and uninstall immediately. The extension's marketplace listing also needs clear feature descriptions and screenshots to set accurate expectations before install.

Context

  • Even if analyst authoring in VS Code/Cursor with preview, diagnostics, and assist works, launch will still fail if external users and operators cannot understand setup, limits, and expected behavior from publishable docs.
  • This task is about making the product externally explainable: clear setup guidance, examples, troubleshooting, and boundary-setting around what is and is not supported at launch.
  • Expected touchpoints include apps/ide/vscode-extension/, preview/inspector runtime code, and extension docs/tests, user-facing docs, operator notes, and any examples or screenshots needed to make the launch story concrete.

Possible Solutions

  • A - Ship with only internal notes and ad hoc examples: faster, but it shifts launch confusion onto support and sales conversations.
  • B - Recommended: produce a focused external-readiness doc set: cover setup, primary workflows, limitations, troubleshooting, and operator/admin guidance where needed.
  • C - Delay docs until after launch traffic appears: saves time now, but increases launch-day friction and inconsistent messaging.

Plan

  1. Define the minimum documentation set needed for external users, internal operators, and anyone supporting analyst authoring in VS Code/Cursor with preview, diagnostics, and assist at launch.
  2. Draft or update the core guides, examples, known-limits sections, and troubleshooting notes using the actual launch scope.
  3. Review the docs against the product behavior and remove any claims that are not yet supportable in the code or operations model.
  4. Link the publishable docs to follow-up maintenance owners so launch documentation does not drift immediately after release.

Implementation Progress

Review Feedback

  • [ ] Review cleared