llms.txt ยท diff
git:20260711.26ea2b5 to git:20260806.e82f3dc
36 added, 33 removed. Audit A to A.
# Semiotic
- > React data visualization library with a schema-backed chart catalog, streaming canvas rendering, coordinated views, and a built-in MCP server for AI-assisted chart generation.
-
- Semiotic provides two tiers: HOC Charts (simple props, sensible defaults) and Stream Frames (full control). Always prefer HOC charts unless you need low-level access. TypeScript strict mode throughout.
+ > React data visualization library with schema-backed chart generation,
+ > streaming canvas rendering, server SVG rendering, coordinated views, and an
+ > MCP server.
Install: `npm install semiotic`
MCP server: `npx semiotic-mcp`
- CLI: `npx semiotic-ai [--schema|--compact|--examples|--doctor]`
-
- Entry points: `semiotic`, `semiotic/xy`, `semiotic/ordinal`, `semiotic/network`, `semiotic/geo`, `semiotic/realtime`, `semiotic/ai`, `semiotic/data`, `semiotic/server`
-
- ## Docs
-
- - [CLAUDE.md](https://github.com/nteract/semiotic/blob/main/CLAUDE.md): Comprehensive AI assistant guide with all component props, patterns, and pitfalls
- - [README](https://github.com/nteract/semiotic/blob/main/README.md): Project overview, MCP server setup, and quick start
- - [CHANGELOG](https://github.com/nteract/semiotic/blob/main/CHANGELOG.md): Version history and migration notes
- - [API Schema](https://github.com/nteract/semiotic/blob/main/ai/schema.json): Machine-readable prop schemas for all 30 components
-
- ## Chart Types
+ CLI: `npx semiotic-ai [--schema|--compact|--examples|--doctor|--audit-a11y]`
- - [XY Charts](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#xy-charts-semioticxy): LineChart, AreaChart, StackedAreaChart, Scatterplot, BubbleChart, ConnectedScatterplot, QuadrantChart, Heatmap
- - [Ordinal Charts](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#ordinal-charts-semioticordinal): BarChart, StackedBarChart, GroupedBarChart, SwarmPlot, BoxPlot, Histogram, ViolinPlot, DotPlot, PieChart, DonutChart
- - [Network Charts](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#network-charts-semioticnetwork): ForceDirectedGraph, SankeyDiagram, ChordDiagram, TreeDiagram, Treemap, CirclePack, OrbitDiagram
- - [Geo Charts](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#geo-charts-semioticgeo): ChoroplethMap, ProportionalSymbolMap, FlowMap, DistanceCartogram
- - [Realtime Charts](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#realtime-charts-semioticrealtime): RealtimeLineChart, RealtimeHistogram, RealtimeSwarmChart, RealtimeWaterfallChart, RealtimeHeatmap
+ ## Start Here
- ## AI Integration
+ - [README](https://github.com/nteract/semiotic/blob/main/README.md): Product
+ overview, installation, entry points, and MCP setup
+ - [Repository Instructions](https://github.com/nteract/semiotic/blob/main/AGENTS.md):
+ Concise guidance for coding agents working in this repository
+ - [System Prompt](https://github.com/nteract/semiotic/blob/main/ai/system-prompt.md):
+ Compact chart-generation guidance and behavior contracts
+ - [Component Schema](https://github.com/nteract/semiotic/blob/main/ai/schema.json):
+ Machine-readable component and prop definitions
+ - [AI Reference](https://github.com/nteract/semiotic/blob/main/ai/reference.md):
+ Comprehensive on-demand product reference
+ - [Examples](https://github.com/nteract/semiotic/blob/main/ai/examples.md):
+ On-demand code patterns by chart and task
+ - [Changelog](https://github.com/nteract/semiotic/blob/main/CHANGELOG.md): Release
+ history and migration notes
- - [MCP Server](https://github.com/nteract/semiotic/blob/main/README.md#mcp-server): MCP tools for schemas, suggestions, diagnosis, static rendering, and ChatGPT Apps widget rendering via renderInteractiveChart
- - [AI Examples](https://github.com/nteract/semiotic/blob/main/ai/examples.md): Code examples for AI code generation
- - [System Prompt](https://github.com/nteract/semiotic/blob/main/ai/system-prompt.md): Compact component reference for LLM context
+ Prefer the system prompt plus one relevant component schema. Retrieve a nearby
+ example or the relevant reference section only when needed; do not load the
+ complete schema, examples, and reference by default.
- ## Features
+ ## Package Entry Points
- - [Coordinated Views](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#coordinated-views): LinkedCharts, CategoryColorProvider, ScatterplotMatrix, cross-highlighting and brushing
- - [Server-Side Rendering](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#server-side-rendering): renderToStaticSVG, automatic SSR in Next.js/Remix/Astro
- - [Push API](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#push-api-on-hoc-charts): Streaming data via ref.current.push() on most HOC charts
- - [Annotations](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#annotations): Widget annotations, threshold coloring, data-anchored React elements
+ Use family subpaths for chart code: `semiotic/xy`, `semiotic/ordinal`,
+ `semiotic/network`, `semiotic/geo`, `semiotic/realtime`, `semiotic/physics`, and
+ `semiotic/value`. Use `semiotic/ai` or the lighter `semiotic/ai/core` for
+ generation and validation helpers, `semiotic/server` for static rendering,
+ `semiotic/recipes` for custom layouts, and `semiotic/themes` or
+ `semiotic/utils` for shared utilities.
- ## Optional
+ Validate generated configurations with `prepareChart`,
+ `npx semiotic-ai --doctor`, or the MCP diagnostic tools. When a renderer is
+ available, confirm non-empty render evidence and run the accessibility audit.
- - [Streaming Sankey](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#realtime-charts-semioticrealtime): StreamNetworkFrame with particles
- - [Realtime Encoding](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#realtime-charts-semioticrealtime): decay, pulse, transition, staleness
- - [Usage Notes](https://github.com/nteract/semiotic/blob/main/CLAUDE.md#usage-notes): Practical chart behavior notes and edge cases
+ The generated documentation catalog is available at
+ [semiotic.nteract.io/llms.txt](https://semiotic.nteract.io/llms.txt), with the
+ expanded reference at
+ [semiotic.nteract.io/llms-full.txt](https://semiotic.nteract.io/llms-full.txt).