Skip to content

Docs site: per-chart prop tables + live examples (beyond playground + API.md) #128

@benzsevern-mjh

Description

@benzsevern-mjh

Why

docs/API.md is a single Markdown file. With ~15 chart types x 27 vibe presets x a brand layer, that doesn't scale — users can't find props, can't preview vibes side-by-side, and the playground (npm run playground) is a single live demo, not a reference.

Spec

Acceptance

  • npm run docs:dev and npm run docs:build scripts.
  • CI builds the docs on PRs; deploys on main alongside the playground.
  • All chart components linked from the docs index.

Notes

  • Auto-generating prop tables off TS types removes drift between docs/API.md and the actual library.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions