Adding base docs

This commit is contained in:
Paul Copplestone committed 2019-10-15 11:14:47 +00:00
1 parent 1fe1664f21
commit 4252efd079
8 files changed
+76 -9

No files matched your search

@@ -4,7 +4,26 @@ export const metadata = {
'A database contains one or more named schemas, which in turn contain tables. Schemas also contain other kinds of named objects, including data types, functions, and operators.',
}
## Intro
## Introduction
A database contains one or more named schemas, which in turn contain tables. Schemas also contain other kinds of named objects, including data types, functions, and operators.
Read more about schemas [here](https://www.postgresql.org/docs/current/ddl-schemas.html).
## GET
Request a list of schemas
```
curl \
https://fakeurl.com
```
## POST
Create a new schema
```
curl \
https://fakeurl.com
```
@@ -0,0 +1,17 @@
export const metadata = {
title: 'Tables',
description:
'Something about tables.',
}
## Introduction
Something about tables
## Request a list of tables
```
curl \
https://fakeurl.com
```
@@ -1,10 +1,10 @@
export const metadata = {
title: 'Realtime',
description: 'Listen to your database updates, inserts, and deletes over websockets.'
description: 'Listen to your database updates, inserts, and deletes over websockets.',
sidebarLabel: 'Overview'
}
# Hello world
## Introduction
FOo bAr
Some overview.
@@ -0,0 +1,10 @@
export const metadata = {
title: 'Installation',
description: 'How to install the server.'
}
## Hello world
FOo bAr
@@ -0,0 +1,18 @@
export const metadata = {
title: 'Realtime JS',
description: 'How to use the JS client.'
}
## Install
```sh
npm install --save @supabase/realtime-js
```
## Usage
```js
// @TODO
```
@@ -1,6 +1,7 @@
export const metadata = {
title: 'Restful',
description: 'Add a fully documented Restful API, simply by introspecting the schema.'
description: 'Add a fully documented Restful API, simply by introspecting the schema.',
sidebarLabel: 'Getting Started'
}
+4 -2
View File
@@ -27,10 +27,12 @@ Sidebars['packaged'] = {
introduction: ['getting-started'],
}
Sidebars['admin-api'] = {
introduction: ['getting-started', 'schemas'],
introduction: ['getting-started'],
API: ['schemas', 'tables'],
}
Sidebars['realtime'] = {
introduction: ['getting-started'],
introduction: ['getting-started', 'installation'],
'Client libraries': ['realtime-js'],
}
Sidebars['restful'] = {
introduction: ['getting-started'],
+1 -1
View File
@@ -271,7 +271,7 @@ h3.has-underline {
border: 1px solid $primary !important;
}
.DocsMenuColumn {
border-right: 2px solid $border-color !important;
border-right: 1px solid $border-color !important;
.menu-label {
padding: 1rem 1rem 0 1rem;