voltage-autodoc
v1.2.2
Published
Auto-documentation generator for Voltage analytics schemas
Maintainers
Readme
Voltage provides type-safe vendor agnostic tracking, an auto-doc of analytics data, and AI ready analytics context.
Features
Instead of providing a feature packed tracker, the tracker provided by voltage acts as a type-safe gate-check for events to pass through before being handed off to another analytics tracker (segment / amplitude / posthog).
Type-Safe Analytics
- Robust analytics schema configuration
- Type-safe tracking generated from schemas
- Agnostic of destination (works with any analytics vendor)
Documentation & Understanding
- Auto-generated documentation of all analytics data
- Rich context for events, properties, and dimensions
- Generates JSON for providing to APIs & AI agents
Installation
npm install voltage-autodocCLI Commands
For keeping the dependencies of voltage-schema at a minimum, a separate devDependency package is provided for voltage-autodoc.
# Open the autodoc in your browser, or output it's HTML for CI
npm voltage-autodoc
npm voltage-autodoc -- --output-html # Output HTML instead of starting serverLicense
MIT
