From 8b511232903f9f1a7909359956941346107af504 Mon Sep 17 00:00:00 2001 From: "Anuar Ustayev (aka Anu)" Date: Sun, 7 May 2023 11:10:26 +0600 Subject: [PATCH] [docs][s]: update and rename components-api.md to components.md --- site/content/docs/{components-api.md => components.md} | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) rename site/content/docs/{components-api.md => components.md} (63%) diff --git a/site/content/docs/components-api.md b/site/content/docs/components.md similarity index 63% rename from site/content/docs/components-api.md rename to site/content/docs/components.md index 0d75237a..cb761af4 100644 --- a/site/content/docs/components-api.md +++ b/site/content/docs/components.md @@ -1,13 +1,9 @@ -# Components API +# Components -You now have a basic data catalog running, the next step would be to dig into the components library. PortalJS supports the following components by default: +PortalJS comes with a library of components that provides essential pieces for your data portal. The best way to explore the components is to look at our [Storybook](https://storybook.portaljs.org/) that contains all the details on how to use them. Below is a quick summary of existing components today: - `` A searchable catalog that will index a list of datasets and allow for contextual searching + filters. - `` A simple component that allows the creation of an opinionated line chart without the need to go deep into charting standards - `` A wrapper around the [Vega specification](https://vega.github.io/vega/) that allows you to build pretty much any kind of chart imaginable - `` A wrapper around the [Vega Lite specification](https://vega.github.io/vega-lite/) which allows for a more concise grammar than Vega around the building of charts. - `` is an easy-to-use table component with built-in pagination, search, and sorting. - -For more details on those please refer to our [Storybook Documentation](https://storybook.portaljs.org/), which contains all the details on how to use them. - -