Skip to content

Commit

Permalink
Update docs site with new documentation links
Browse files Browse the repository at this point in the history 
Signed-off-by: Andrew Stein <steinlink@gmail.com>
  • Loading branch information
@texodus
texodus committed Oct 17, 2024
1 parent 3b7559d commit 8a01cac
Show file tree
Hide file tree
Showing 6 changed files with 155 additions and 82 deletions.
11 changes: 3 additions & 8 deletions docs/docs/development.md → DEVELOPMENT.md
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
---
id: development
title: Developer Guide
---

Thank you for your interest in contributing to Perspective! This guide will
teach you everything you need to know to get started hacking on the Perspective
codebase.
This guide will teach you everything you need to know to get started hacking on
the Perspective codebase. Please see [`CONTRIBUTING.md`](CONTRIBUTING.md) for
contribution guidelines.

If you're coming to this project as principally a JavaScript developer, please
be aware that Perspective is quite a bit more complex than a typical NPM package
Expand Down
58 changes: 31 additions & 27 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,31 @@ and/or [Jupyterlab](https://jupyterlab.readthedocs.io/en/stable/).
### Documentation

- [Project Site](https://perspective.finos.org/)
- User Guides
- [Javascript User Guide](https://perspective.finos.org/docs/js.html)
- [Python User Guide](https://perspective.finos.org/docs/python.html)
- [Developer Guide](https://perspective.finos.org/docs/development.html)
- Concepts
- [Table](https://perspective.finos.org/docs/table.html)
- [View](https://perspective.finos.org/docs/view.html)
- [Expression Columns](https://perspective.finos.org/docs/expressions.html)
- [Data Binding](https://perspective.finos.org/docs/table.html)
- API
- [Perspective API](https://github.com/finos/perspective/blob/master/packages/perspective/README.md)
- [Perspective Viewer API](https://perspective.finos.org/docs/obj/perspective-viewer/)
- [Perspective Python API](https://perspective.finos.org/docs/obj/perspective-python.html)
- JavaScript (NPM)
- [`@finos/perspective-viewer`, JavaScript UI API](https://docs.rs/perspective-viewer/latest/perspective_viewer/)
- [`@finos/perspective`, JavaScript Client/Server API](https://docs.rs/perspective-js/latest/perspective_js/)
- [`Table` API](https://docs.rs/perspective-js/latest/perspective_js/struct.Table.html)
- [`View` API](https://docs.rs/perspective-js/latest/perspective_js/struct.View.html)
- [Installation Guide](https://docs.rs/perspective-js/latest/perspective_js/#installation)
- Python (PyPI)
- [`perspective-python`, Python Client/Server API](https://docs.rs/perspective-python/latest/perspective_python/)
- [`PerspectiveWidget` Jupyter Plugin](https://docs.rs/perspective-python/3.1.0/perspective_python/#perspectivewidget)
- [`Table` API](https://docs.rs/perspective-python/latest/perspective_python/struct.Table.html)
- [`View` API](https://docs.rs/perspective-python/latest/perspective_python/struct.View.html)
- Rust (Crates.io)
- [`perspective`, Rust API](https://docs.rs/perspective-rs/latest/perspective_rs/)
- [`perspective-client`, Rust Client API](https://docs.rs/perspective-client/latest/perspective_client/)
- [`perspective-server`, Rust Server API](https://docs.rs/perspective-server/latest/perspective_server/)
- [`Table` API](https://docs.rs/perspective-client/latest/perspective_client/struct.Table.html)
- [`View` API](https://docs.rs/perspective-client/latest/perspective_client/struct.View.html)
- Appendix
- [Data Binding](https://docs.rs/perspective-server/latest/perspective_server/)
- [Expression Columns](https://docs.rs/perspective-client/latest/perspective_client/config/expressions/)

### Examples

<!-- Examples -->
<table><tbody><tr><td>editable</td><td>file</td><td>fractal</td></tr><tr><td><a href="https://perspective.finos.org/block?example=editable"><img height="125" src="https://perspective.finos.org/blocks/editable/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=file"><img height="125" src="https://perspective.finos.org/blocks/file/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=fractal"><img height="125" src="https://perspective.finos.org/blocks/fractal/preview.png?"></img></a></td></tr><tr><td>market</td><td>raycasting</td><td>evictions</td></tr><tr><td><a href="https://perspective.finos.org/block?example=market"><img height="125" src="https://perspective.finos.org/blocks/market/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=raycasting"><img height="125" src="https://perspective.finos.org/blocks/raycasting/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=evictions"><img height="125" src="https://perspective.finos.org/blocks/evictions/preview.png?"></img></a></td></tr><tr><td>nypd</td><td>streaming</td><td>covid</td></tr><tr><td><a href="https://perspective.finos.org/block?example=nypd"><img height="125" src="https://perspective.finos.org/blocks/nypd/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=streaming"><img height="125" src="https://perspective.finos.org/blocks/streaming/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=covid"><img height="125" src="https://perspective.finos.org/blocks/covid/preview.png?"></img></a></td></tr><tr><td>webcam</td><td>movies</td><td>superstore</td></tr><tr><td><a href="https://perspective.finos.org/block?example=webcam"><img height="125" src="https://perspective.finos.org/blocks/webcam/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=movies"><img height="125" src="https://perspective.finos.org/blocks/movies/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=superstore"><img height="125" src="https://perspective.finos.org/blocks/superstore/preview.png?"></img></a></td></tr><tr><td>citibike</td><td>olympics</td><td>jupyterlab</td></tr><tr><td><a href="https://perspective.finos.org/block?example=citibike"><img height="125" src="https://perspective.finos.org/blocks/citibike/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=olympics"><img height="125" src="https://perspective.finos.org/blocks/olympics/preview.png?"></img></a></td><td><a href="http://beta.mybinder.org/v2/gh/finos/perspective/master?urlpath=lab/tree/examples/jupyter-notebooks"><img height="125" src="https://perspective.finos.org/img/jupyterlab.png?"></img></a></td></tr></tbody></table>
<table><tbody><tr><td>editable</td><td>file</td><td>fractal</td></tr><tr><td><a href="https://perspective.finos.org/block?example=editable"><img height="125" src="https://perspective.finos.org/blocks/editable/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=file"><img height="125" src="https://perspective.finos.org/blocks/file/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=fractal"><img height="125" src="https://perspective.finos.org/blocks/fractal/preview.png?"></img></a></td></tr><tr><td>market</td><td>raycasting</td><td>evictions</td></tr><tr><td><a href="https://perspective.finos.org/block?example=market"><img height="125" src="https://perspective.finos.org/blocks/market/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=raycasting"><img height="125" src="https://perspective.finos.org/blocks/raycasting/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=evictions"><img height="125" src="https://perspective.finos.org/blocks/evictions/preview.png?"></img></a></td></tr><tr><td>nypd</td><td>streaming</td><td>covid</td></tr><tr><td><a href="https://perspective.finos.org/block?example=nypd"><img height="125" src="https://perspective.finos.org/blocks/nypd/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=streaming"><img height="125" src="https://perspective.finos.org/blocks/streaming/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=covid"><img height="125" src="https://perspective.finos.org/blocks/covid/preview.png?"></img></a></td></tr><tr><td>webcam</td><td>movies</td><td>superstore</td></tr><tr><td><a href="https://perspective.finos.org/block?example=webcam"><img height="125" src="https://perspective.finos.org/blocks/webcam/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=movies"><img height="125" src="https://perspective.finos.org/blocks/movies/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=superstore"><img height="125" src="https://perspective.finos.org/blocks/superstore/preview.png?"></img></a></td></tr><tr><td>citibike</td><td>olympics</td></tr><tr><td><a href="https://perspective.finos.org/block?example=citibike"><img height="125" src="https://perspective.finos.org/blocks/citibike/preview.png?"></img></a></td><td><a href="https://perspective.finos.org/block?example=olympics"><img height="125" src="https://perspective.finos.org/blocks/olympics/preview.png?"></img></a></td></tr></tbody></table>
<!-- Examples -->

### Media
Expand All @@ -65,22 +72,19 @@ and/or [Jupyterlab](https://jupyterlab.readthedocs.io/en/stable/).
<td><a href="https://github.com/timbess"><code>@timbess</code></a></td>
<td><a href="https://github.com/sc1f"><code>@sc1f</code></a></td>
</tr>
<tr><td>
<a href="https://www.youtube.com/watch?v=s6n9vEyM1gY"><img width="240" src="https://img.youtube.com/vi/s6n9vEyM1gY/0.jpg" /></a>
</td><td>
<a href="https://www.youtube.com/watch?v=lDpIu4dnp78"><img width="240" src="https://img.youtube.com/vi/lDpIu4dnp78/0.jpg" /></a>
</td><td>
<a href="https://www.youtube.com/watch?v=IO-HJsGdleE"><img width="240" src="https://img.youtube.com/vi/IO-HJsGdleE/0.jpg" /></a>
</td></tr>
<tr>
<td><a href="https://www.youtube.com/watch?v=v5Y5ftlGNhU"><img width="240" src="https://img.youtube.com/vi/v5Y5ftlGNhU/0.jpg" /></a></td>
<td><a href="https://www.youtube.com/watch?v=lDpIu4dnp78"><img width="240" src="https://img.youtube.com/vi/lDpIu4dnp78/0.jpg" /></a></td>
<td><a href="https://www.youtube.com/watch?v=0ut-ynvBpGI"><img width="240" src="https://img.youtube.com/vi/0ut-ynvBpGI/0.jpg" /></a></td>
</tr>
<tr>
<td><a href="https://github.com/texodus"><code>@texodus</code></a></td>
<td><a href="https://github.com/texodus"><code>@texodus</code></a></td>
<td></td>
</tr>
<tr><td>
<a href="https://www.youtube.com/watch?v=0ut-ynvBpGI"><img width="240" src="https://img.youtube.com/vi/0ut-ynvBpGI/0.jpg" /></a>
</td><td>
<a href="https://www.youtube.com/watch?v=no0qChjvdgQ"><img width="240" src="https://img.youtube.com/vi/no0qChjvdgQ/0.jpg" /></a>
</td><td>
</td></tr>
<tr>
<td><a href="https://www.youtube.com/watch?v=no0qChjvdgQ"><img width="240" src="https://img.youtube.com/vi/no0qChjvdgQ/0.jpg" /></a></td>
<td><a href="https://www.youtube.com/watch?v=IO-HJsGdleE"><img width="240" src="https://img.youtube.com/vi/IO-HJsGdleE/0.jpg" /></a></td>
<td></td>
</tr>
</tbody></table>
153 changes: 113 additions & 40 deletions docs/docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,17 @@ const config = {
"classic",
/** @type {import('@docusaurus/preset-classic').Options} */
({
docs: {
sidebarPath: require.resolve("./sidebars.js"),
docItemComponent: require.resolve(
"./src/components/DocItem"
),
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// editUrl:
// "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
},
docs: false,
// docs: {
// // sidebarPath: require.resolve("./sidebars.js"),
// docItemComponent: require.resolve(
// "./src/components/DocItem"
// ),
// // Please change this to your repo.
// // Remove this to remove the "edit this page" links.
// // editUrl:
// // "https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/",
// },
// blog: {
// showReadingTime: true,
// // Please change this to your repo.
Expand Down Expand Up @@ -112,12 +113,84 @@ const config = {
src: "svg/perspective-logo-light.svg",
},
items: [
// {to: "/blog", label: "News", position: "right"},
{
type: "doc",
docId: "js",
type: "dropdown",
position: "right",
label: "Docs",
items: [
{
type: "html",
value: "<span>JavaScript</span>",
},
{
href: "https://docs.rs/perspective-viewer/latest/perspective_viewer/",
label: "`@finos/perspective-viewer` JavaScript UI API",
},
{
href: "https://docs.rs/perspective-js/latest/perspective_js/",
label: "`@finos/perspective` JavaScript Client/Server API",
},
{
href: "https://docs.rs/perspective-js/latest/perspective_js/struct.Table.html",
label: "`Table` API",
},
{
href: "https://docs.rs/perspective-js/latest/perspective_js/struct.View.html",
label: "`View` API",
},
{
href: "https://docs.rs/perspective-js/latest/perspective_js/#installation",
label: "Installation Guide",
},
{
type: "html",
value: "<span>Python</span>",
},
{
href: "https://docs.rs/perspective-python/latest/perspective_python/",
label: "`perspective-python` Python Client/Server API",
},
{
href: "https://docs.rs/perspective-python/3.1.0/perspective_python/#perspectivewidget",
label: "`PerspectiveWidget` Jupyter Plugin",
},
{
href: "https://docs.rs/perspective-python/latest/perspective_python/struct.Table.html",
label: "`Table` API",
},
{
href: "https://docs.rs/perspective-python/latest/perspective_python/struct.View.html",
label: "`View` API",
},
{
type: "html",
value: "<span>Rust</span>",
},
{
href: "https://docs.rs/perspective/latest/perspective/",
label: "`perspective`, Rust API",
},
{
href: "https://docs.rs/perspective-client/latest/perspective_client/struct.Table.html",
label: "`Table` API",
},
{
href: "https://docs.rs/perspective-client/latest/perspective_client/struct.View.html",
label: "`View` API",
},
{
type: "html",
value: "<span>Appendix</span>",
},
{
href: "https://docs.rs/perspective-server/latest/perspective_server/",
label: "Data Binding",
},
{
href: "https://docs.rs/perspective-client/latest/perspective_client/config/expressions/",
label: "Expression Columns",
},
],
},
{
to: "/examples",
Expand All @@ -138,33 +211,33 @@ const config = {
},
footer: {
links: [
{
title: "Docs",
items: [
{
label: "JavaScript User Guide",
to: "/docs/js",
},
{
label: "Python User Guide",
to: "/docs/python",
},
],
},
{
title: "More",
items: [
{
label: "GitHub",
href: "https://github.com/finos/perspective",
},
{
href: "https://www.prospective.co/blog",
label: "Blog",
position: "right",
},
],
},
// {
// title: "Docs",
// items: [
// {
// label: "JavaScript User Guide",
// to: "/docs/js",
// },
// {
// label: "Python User Guide",
// to: "/docs/python",
// },
// ],
// },
// {
// title: "More",
// items: [
// {
// label: "GitHub",
// href: "https://github.com/finos/perspective",
// },
// {
// href: "https://www.prospective.co/blog",
// label: "Blog",
// position: "right",
// },
// ],
// },
],
copyright: `Copyright © ${new Date().getFullYear()} The Perspective Authors`,
},
Expand Down
1 change: 1 addition & 0 deletions docs/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"version": "3.1.0",
"private": true,
"scripts": {
"build": "node build.js && docusaurus build",
"docusaurus": "docusaurus",
"start": "docusaurus start",
"docs": "node build.js && docusaurus build",
Expand Down
Loading

0 comments on commit 8a01cac

Please sign in to comment.