diff --git a/web/docs/api/getting-started.mdx b/web/docs/api/getting-started.mdx deleted file mode 100755 index c0abe502183..00000000000 --- a/web/docs/api/getting-started.mdx +++ /dev/null @@ -1,6 +0,0 @@ ---- -id: getting-started -title: Getting Started ---- - -@todo \ No newline at end of file diff --git a/web/docs/faq.md b/web/docs/faq.md index 57bd1b304fa..f54d3612f04 100755 --- a/web/docs/faq.md +++ b/web/docs/faq.md @@ -1,6 +1,6 @@ --- id: faq -title: FAQ's +title: FAQs --- @todo \ No newline at end of file diff --git a/web/docs/api/authentication.mdx b/web/docs/library/authentication.mdx similarity index 100% rename from web/docs/api/authentication.mdx rename to web/docs/library/authentication.mdx diff --git a/web/docs/library/getting-started.mdx b/web/docs/library/getting-started.mdx new file mode 100755 index 00000000000..eaac76c120f --- /dev/null +++ b/web/docs/library/getting-started.mdx @@ -0,0 +1,79 @@ +--- +id: getting-started +title: Getting Started +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +## Including Supabase +--- + + + +```js +import { Supabase } from "@supabase/supabase-js"; +``` + + + + +```py +from supabase import Supabase +``` + + + + +## Initializing +--- +### Supabase(supabaseURL, supabaseKey, options?) +This is used to initialize an instance of a Supabase object. From here, you would be able +to access all of the features provided by Supabase. + + +### Examples + + + +```js +const supabase = Supabase("https://supabase.io/xyzcompany", "1a2b-3c4d-5e6f-7g8h"); +``` + + + + +```py +supabase = Supabase("https://supabase.io/xyzcompany", "1a2b-3c4d-5e6f-7g8h") +``` + + + +### Method arguments +#### supabaseURL +`required` string +Your unique Supabase URL. + +#### supabaseKey +`required` string +Your unique Supabase Key. + +#### options +`optional` object + +| Parameter | Data Type | Description | +| ----------- | --------- | ----------- | +| @todo | | | + diff --git a/web/docs/api/subscribe.mdx b/web/docs/library/realtime/subscribe.mdx similarity index 94% rename from web/docs/api/subscribe.mdx rename to web/docs/library/realtime/subscribe.mdx index a76fcfbaf01..1d81ea5b0b8 100644 --- a/web/docs/api/subscribe.mdx +++ b/web/docs/library/realtime/subscribe.mdx @@ -1,6 +1,6 @@ --- id: subscribe -title: "Subscribe to realtime changes" +title: "Subscribe to Realtime Changes" --- Our library makes it simple to listen to changes in your database. diff --git a/web/docs/api/delete.mdx b/web/docs/library/restful/delete.mdx similarity index 94% rename from web/docs/api/delete.mdx rename to web/docs/library/restful/delete.mdx index cb4040257e2..9d1688b3e25 100644 --- a/web/docs/api/delete.mdx +++ b/web/docs/library/restful/delete.mdx @@ -1,6 +1,6 @@ --- id: delete -title: 'Remove rows' +title: 'Remove Rows' --- @todo short Description diff --git a/web/docs/api/get.mdx b/web/docs/library/restful/get.mdx similarity index 97% rename from web/docs/api/get.mdx rename to web/docs/library/restful/get.mdx index e125a28bf08..a86dcecfad0 100644 --- a/web/docs/api/get.mdx +++ b/web/docs/library/restful/get.mdx @@ -1,6 +1,6 @@ --- id: get -title: 'Fetch your data' +title: 'Fetch Your Data' --- @todo short Description diff --git a/web/docs/api/patch.mdx b/web/docs/library/restful/patch.mdx similarity index 94% rename from web/docs/api/patch.mdx rename to web/docs/library/restful/patch.mdx index 73f4f398b04..27f2e560641 100644 --- a/web/docs/api/patch.mdx +++ b/web/docs/library/restful/patch.mdx @@ -1,6 +1,6 @@ --- id: patch -title: 'Update rows' +title: 'Update Rows' --- @todo short Description diff --git a/web/docs/api/post.mdx b/web/docs/library/restful/post.mdx similarity index 97% rename from web/docs/api/post.mdx rename to web/docs/library/restful/post.mdx index 7ca5765f078..955440f03f3 100644 --- a/web/docs/api/post.mdx +++ b/web/docs/library/restful/post.mdx @@ -1,6 +1,6 @@ --- id: post -title: 'Create new rows' +title: 'Create New Rows' --- diff --git a/web/sidebars.js b/web/sidebars.js index ec52504b8d8..72b7247c94f 100755 --- a/web/sidebars.js +++ b/web/sidebars.js @@ -6,34 +6,33 @@ */ module.exports = { - docs: [ - { - type: "category", - label: "Introduction", - items: [ - "about", - "faq", - ] - }, - { - type: "category", - label: "API", - items: [ - "api/getting-started", - "api/authentication", - "api/subscribe", - "api/get", - "api/post", - "api/patch", - "api/delete", - ] - }, - { - type: "category", - label: "Guides", - items: [ - "guides/examples", - ] - } - ] + docs: { + Introduction:[ + "about", + "faq" + ], + Library:[ + "library/getting-started", + { + type: "category", + label: "Realtime", + items: [ + "library/realtime/subscribe" + ] + }, + { + type: "category", + label: "RESTful", + items: [ + "library/restful/get", + "library/restful/post", + "library/restful/patch", + "library/restful/delete" + ] + } + ], + Guides:[ + "guides/examples" + ] + } };