Skip to content

Commit

Permalink
docs: add overview page
Browse files Browse the repository at this point in the history
  • Loading branch information
korvin89 committed Feb 9, 2025
1 parent e249327 commit 70a873c
Show file tree
Hide file tree
Showing 5 changed files with 55 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/diplodoc/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ meta:
title: Gravity UI Charts
noIndex: true
links:
- title: Overview
href: ./pages/overview.md
- title: Get started
href: ./pages/get-started.md
- title: API
Expand Down
6 changes: 3 additions & 3 deletions docs/diplodoc/pages/get-started.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Get started
# Get started

### Install
## Install

```shell
npm install @gravity-ui/uikit @gravity-ui/charts
```

### Development
## Development

To start the development server with storybook run the following:

Expand Down
43 changes: 43 additions & 0 deletions docs/diplodoc/pages/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Overview

## About Gravity UI Charts

**Gravity UI Charts** is a charting library built with [D3](https://d3js.org/) and [React](https://react.dev/). It's designed as part of the [Gravity UI](https://gravity-ui.com/) ecosystem and provides powerful data visualization capabilities for modern web applications through simple configuration objects.

{% note warning %}

While the library is in version `0.*.*`, minor releases may include incompatible changes to the API.

{% endnote %}

## What you can already do with Gravity UI Charts

We have already implemented support for the main chart types:

- `Area`
- `Bar-X`
- `Bar-Y`
- `Line`
- `Pie`
- `Scatter`
- `Treemap` (partial support)
- `Waterfall` (partial support)

{% cut "Examples from Storybook" %}

<iframe
src="https://preview.gravity-ui.com/charts/iframe.html?args=&globals=&id=showcase--d-3-showcase-story&viewMode=story"
width="100%"
height="400"
></iframe>

{% endcut %}

## Roadmap

We are actively working on library development and continuously improving its features. Here is the list of the priority major features:

- ⏳ Handling null data [#28](https://github.com/gravity-ui/charts/issues/28)
- ⏳ Charts zooming [#29](https://github.com/gravity-ui/charts/issues/29)
- ⏳ Plot lines, bands [#30](https://github.com/gravity-ui/charts/issues/30)
- ⏳ Charts navigator [#35](https://github.com/gravity-ui/charts/issues/35)
6 changes: 6 additions & 0 deletions docs/diplodoc/toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,16 @@ navigation:
icon: https://storage.yandexcloud.net/gravity-ui-assets/gravity-logo-light.svg
text: Charts
header:
leftItems:
- text: Github ➚
type: link
url: https://github.com/gravity-ui/charts
rightItems:
- type: controls
- type: search
items:
- name: Overview
href: ./pages/overview.md
- name: Get started
href: ./pages/get-started.md
- name: API
Expand Down
2 changes: 1 addition & 1 deletion docs/gulpfile.docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ function reload(cb) {
}

function watchFiles() {
watch(['./docs/diplodoc/**/*', './docs/src/**/*', '../src/**/*'], series(build, reload));
watch(['./diplodoc/**/*', './src/**/*', '../src/**/*'], series(build, reload));
}

exports.default = series(build, parallel(serve, watchFiles));

0 comments on commit 70a873c

Please sign in to comment.