Dataface Tasks
    Heartbeat snapshot (JSON)

    Launch docs and external readiness

    IDM3_PUBLIC_LAUNCH-DFT_CORE-02
    Statusnot_started
    Priorityp0
    Milestonem3-public-launch
    Ownerhead-of-engineering

    Problem

    There is no external-facing documentation for the execution adapters. New users who install the core runtime have no reference for how to configure a database source, write a query in a dashboard YAML, or troubleshoot adapter-specific errors. The existing internal docs assume familiarity with the codebase and are not structured as executable getting-started guides. Without launch-quality documentation, external users cannot adopt the runtime without reverse-engineering the source code.

    Context

    • Even if the YAML contract, compiler/normalizer, execution adapters, and release/versioning 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 dataface/core/, schema/compiled types, docs, and core test suites, 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 the YAML contract, compiler/normalizer, execution adapters, and release/versioning 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