diff --git a/docs/getting-started.md b/docs/getting-started.md index 88a1d61..c0159e3 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -18,8 +18,8 @@ How is the Gosling grammar used in practice? A Gosling visualization is defined -## Javascript API +## React Component API -**Gosling.js** takes the Gosling specification as an input and creates the visualization defined by it. You can programmatically interact with this visualization using **Javascript API functions**. +**Gosling.js** takes the Gosling specification as an input and creates the visualization defined by it. You can programmatically interact with this visualization using the [React component API](react-api). For example, you can use an API function to make the visualization zoom to a particular genomic position, or you can subscribe to click events in the visualization. This is useful to building your own interactive visualizations with Gosling! \ No newline at end of file diff --git a/docs/js-api.md b/docs/react-api.md similarity index 99% rename from docs/js-api.md rename to docs/react-api.md index 46ac88d..bbaca3c 100644 --- a/docs/js-api.md +++ b/docs/react-api.md @@ -1,5 +1,5 @@ --- -title: JavaScript API +title: React Component API --- ## GoslingComponent diff --git a/sidebarDocs.js b/sidebarDocs.js index a2dba5d..f633afd 100644 --- a/sidebarDocs.js +++ b/sidebarDocs.js @@ -37,8 +37,8 @@ module.exports = { }, { type: 'doc', - label: 'JavaScript API', - id: 'js-api', + label: 'React Component API', + id: 'react-api', }, { type: 'doc',