New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Documentation #340

Open

miralemd opened this issue Mar 6, 2020 · 0 comments

Contributor

miralemd commented Mar 6, 2020

Getting started
- Installation
  - npm, yarn, CDN
- What is nebula.js?
- Usage
  - Connecting to engine
  - Rendering a chart
Nucleus guide
- Configuration
  - theme, language
  - constraints
  - types
    - loading charts on the fly with d3-require
  - themes
  - snapshots
- rendering charts
  - element requirements - size position
  - by type
    - initial fields
  - by id
- app selections
- supernova controller
  - set properties
  - export image
  - set options
Supernova guide
- Prerequisites
- instant prototyping
- Hello world
- Component + QAE
- Add stuff to element
- Consume data
- Basic hooks
- actions
- Use theme
- use translator
- Use model, app, global
- Snapshots
- Options + imperative handle
- Build + publish
  - loaders
  - peer deps
CLI
- install
- serve
- build
- create
Guides
- API design approach
- Testing
API reference
- nucleus
- supernova
- snapshooter
- CLI
  - create
  - build
  - serve
  - nebula config
FAQ
- Versioning policy, API governance and release tracks
- Browser support

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment