Launch docs and external readiness
Problem
External users encountering Dataface's chart library for the first time have no documentation explaining which chart types are available, what the default styling behavior is, how to customize colors/axes/labels, or what data shapes each chart type expects. Internal knowledge about the visual language system lives in code, design docs, and team context — none of which is accessible to new users. Without executable examples (YAML snippets that produce real charts) and clear reference documentation, adoption will stall at the "how do I make a basic line chart" stage regardless of how good the rendering is.
Context
- Even if visual language, chart defaults, interaction behavior, and differentiated styling 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/render/chart/, chart design docs, examples, and visualization test coverage, 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
- Define the minimum documentation set needed for external users, internal operators, and anyone supporting visual language, chart defaults, interaction behavior, and differentiated styling at launch.
- Draft or update the core guides, examples, known-limits sections, and troubleshooting notes using the actual launch scope.
- Review the docs against the product behavior and remove any claims that are not yet supportable in the code or operations model.
- Link the publishable docs to follow-up maintenance owners so launch documentation does not drift immediately after release.
Implementation Progress
Review Feedback
- [ ] Review cleared