diff --git a/apps/reference/_api/intro.md b/apps/reference/_api/intro.md index 5bd32acd56d..d10d6bd02c3 100644 --- a/apps/reference/_api/intro.md +++ b/apps/reference/_api/intro.md @@ -1,7 +1,7 @@ --- slug: / sidebar_position: 1 -sidebar_label: Introduction +sidebar_label: Supabase API --- # Supabase API diff --git a/apps/reference/_cli/intro.mdx b/apps/reference/_cli/intro.mdx index e80457aeb6f..e11e387e866 100644 --- a/apps/reference/_cli/intro.mdx +++ b/apps/reference/_cli/intro.mdx @@ -2,7 +2,7 @@ id: intro slug: / sidebar_position: 1 -sidebar_label: Introduction +sidebar_label: Supabase CLI --- # Supabase CLI diff --git a/apps/reference/_supabase_dart/intro.mdx b/apps/reference/_supabase_dart/intro.mdx index e2cd0baaae2..ed3946e9b0c 100644 --- a/apps/reference/_supabase_dart/intro.mdx +++ b/apps/reference/_supabase_dart/intro.mdx @@ -1,10 +1,10 @@ --- id: intro slug: / -sidebar_label: Introduction +sidebar_label: Supabase Dart Library --- -# Supabase Dart +# Supabase Dart Library Dart libraries are built and supported by the community. diff --git a/apps/reference/_supabase_dart_versioned_docs/version-1.0/intro.mdx b/apps/reference/_supabase_dart_versioned_docs/version-1.0/intro.mdx deleted file mode 100644 index e2cd0baaae2..00000000000 --- a/apps/reference/_supabase_dart_versioned_docs/version-1.0/intro.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -id: intro -slug: / -sidebar_label: Introduction ---- - -# Supabase Dart - -Dart libraries are built and supported by the community. - -```bash -dart pub add supabase -``` - -Find the source code on [GitHub](https://github.com/supabase/supabase-dart). - -## Flutter - -For Flutter project, you can use [supabase_flutter](https://github.com/supabase/supabase-flutter). - -```bash -flutter pub add supabase_flutter -``` - -`supabase_flutter` plugin uses `supabase` plugin internally, and it adds some Flutter specific functionality such as handling deeplinks coming back from magic link verifications. -If you are creating a Flutter application, we recommend using `supabase_flutter` instead of `supabase`. - -For the most part `supabase_flutter` shares the same API as `supabase` with few exceptions such as initialization or OAuth sign in. diff --git a/apps/reference/_supabase_dart_versioned_docs/version-1.0/release-notes.mdx b/apps/reference/_supabase_dart_versioned_docs/version-1.0/release-notes.mdx deleted file mode 100644 index 77883904adc..00000000000 --- a/apps/reference/_supabase_dart_versioned_docs/version-1.0/release-notes.mdx +++ /dev/null @@ -1,7 +0,0 @@ ---- -id: release-notes ---- - -# Release Notes - -Start your release notes here. \ No newline at end of file diff --git a/apps/reference/_supabase_dart_versioned_docs/version-1.0/usage.mdx b/apps/reference/_supabase_dart_versioned_docs/version-1.0/usage.mdx deleted file mode 100644 index 8f501838e30..00000000000 --- a/apps/reference/_supabase_dart_versioned_docs/version-1.0/usage.mdx +++ /dev/null @@ -1,115 +0,0 @@ ---- -id: usage -title: Usage ---- - - - - -Supabase Dart. - - - - - - - - -## Initializing the client library - -```dart -final supabase = SupabaseClient('', ''); -``` - - -### Attributes - - - - -### Notes - -## Dart -You can initialize a new Supabase client using the `SupabaseClient()` method. - -The Supabase client is your entrypoint to the rest of the Supabase functionality -and is the easiest way to interact with everything we offer within the Supabase ecosystem. - - -## Flutter - -For `supabase_flutter`, you will be using the static `initialize()` method on `Supabase` class. - - -### Examples - - - -#### - -```dart -final supabase = SupabaseClient('https://xyzcompany.supabase.co', 'public-anon-key'); -``` - - - - -#### - -```dart title="main.dart" -Future main() async { - await Supabase.initialize(url: 'https://xyzcompany.supabase.co', anonKey: 'public-anon-key'); - runApp(MyApp()); -} -``` - - - - - - -## Create a new user. - -```dart -final res = await supabase.auth.signUp('', ''); -``` - - -### Attributes - - - - -### Notes - -- By default, the user will need to verify their email address before logging in. If you would like to change this, you can disable "Email Confirmations" by going to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) -- If "Email Confirmations" is turned on, a user is returned but session will be null -- If "Email Confirmations" is turned off, both a `user` and a `session` will be returned -- When the user confirms their email address, they will be redirected to localhost:3000 by default. To change this, you can go to Authentication -> Settings on [app.supabase.com](https://app.supabase.com) - - -### Examples - - - -#### Sign up. - -```dart -final res = await supabase.auth.signUp('example@email.com', 'example-password'); - -final user = res.data?.user; -final error = res.error; -``` - - - - -#### Sign up with third-party providers. - -```dart -// Use signInWithProvider() -``` - - - - diff --git a/apps/reference/_supabase_dart_versioned_sidebars/version-1.0-sidebars.json b/apps/reference/_supabase_dart_versioned_sidebars/version-1.0-sidebars.json deleted file mode 100644 index dd25946fbf3..00000000000 --- a/apps/reference/_supabase_dart_versioned_sidebars/version-1.0-sidebars.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "goTrueSidebar": ["intro", "usage", "release-notes"] -} diff --git a/apps/reference/_supabase_dart_versions.json b/apps/reference/_supabase_dart_versions.json index 7e20b00b2fe..fe51488c706 100644 --- a/apps/reference/_supabase_dart_versions.json +++ b/apps/reference/_supabase_dart_versions.json @@ -1 +1 @@ -["1.0"] +[] diff --git a/apps/reference/_supabase_js/intro.md b/apps/reference/_supabase_js/intro.md index d756d0ed2aa..370ba96498e 100644 --- a/apps/reference/_supabase_js/intro.md +++ b/apps/reference/_supabase_js/intro.md @@ -1,9 +1,9 @@ --- slug: / sidebar_position: 1 -sidebar_label: Introduction +sidebar_label: Supabase JavaScript Library --- -# Supabase JavaScript Client +# Supabase JavaScript Library Some docs diff --git a/apps/reference/docusaurus.config.js b/apps/reference/docusaurus.config.js index 0f640f5610f..08671bd8144 100644 --- a/apps/reference/docusaurus.config.js +++ b/apps/reference/docusaurus.config.js @@ -53,7 +53,7 @@ const config = { { id: '_gotrue', path: '_gotrue', - routeBasePath: 'gotrue', + routeBasePath: 'auth', sidebarPath: require.resolve('./nav/gotrue_sidebars.js'), breadcrumbs: false, }, diff --git a/apps/reference/nav/_referenceNavbar.js b/apps/reference/nav/_referenceNavbar.js index 20d8a3fe8af..6df48a58481 100644 --- a/apps/reference/nav/_referenceNavbar.js +++ b/apps/reference/nav/_referenceNavbar.js @@ -79,31 +79,31 @@ const navbar = [ // GoTrue { - to: 'gotrue', + to: 'auth', position: 'left', - label: 'GoTrue Auth Server', - supabaseCustomNavBarRegex: '(^/gotrue$|gotrue/)', - }, - { - type: 'docsVersionDropdown', - position: 'left', - docsPluginId: '_gotrue', - supabaseCustomNavBarRegex: '(^/gotrue$|gotrue/)', + label: 'Auth Server', + supabaseCustomNavBarRegex: '(^/auth$|auth/)', }, + // { + // type: 'docsVersionDropdown', + // position: 'left', + // docsPluginId: '_gotrue', + // supabaseCustomNavBarRegex: '(^/gotrue$|gotrue/)', + // }, // Storage { to: 'storage', position: 'left', - label: 'GoTrue Auth Server', - supabaseCustomNavBarRegex: '(^/storage$|storage/)', - }, - { - type: 'docsVersionDropdown', - position: 'left', - docsPluginId: '_storage', + label: 'Storage Server', supabaseCustomNavBarRegex: '(^/storage$|storage/)', }, + // { + // type: 'docsVersionDropdown', + // position: 'left', + // docsPluginId: '_storage', + // supabaseCustomNavBarRegex: '(^/storage$|storage/)', + // }, /** * COMMUNITY @@ -114,12 +114,12 @@ const navbar = [ label: 'Supabase Dart SDK', supabaseCustomNavBarRegex: '(^/supabase-dart$|supabase-dart/)', }, - { - type: 'docsVersionDropdown', - position: 'left', - docsPluginId: '_supabase_dart', - supabaseCustomNavBarRegex: '(^/supabase-dart$|supabase-dart/)', - }, + // { + // type: 'docsVersionDropdown', + // position: 'left', + // docsPluginId: '_supabase_dart', + // supabaseCustomNavBarRegex: '(^/supabase-dart$|supabase-dart/)', + // }, ] module.exports = { navbar } diff --git a/apps/reference/nav/_referenceSidebars.js b/apps/reference/nav/_referenceSidebars.js index c7e78ca5ea0..76a303af3e8 100644 --- a/apps/reference/nav/_referenceSidebars.js +++ b/apps/reference/nav/_referenceSidebars.js @@ -20,14 +20,18 @@ const sidebars = { link: { type: 'doc', id: 'about' }, collapsed: false, items: [ - { - type: 'link', - label: 'Supabase JavaScript Client', - href: '/supabase-js', - }, { type: 'link', label: 'Supabase CLI', href: '/cli' }, { type: 'link', label: 'Supabase API', href: '/api' }, - { type: 'link', label: 'Supabase Dart Client', href: '/supabase-dart' }, + { + type: 'link', + label: 'Supabase JavaScript Library', + href: '/supabase-js', + }, + { + type: 'link', + label: 'Supabase Dart Library', + href: '/supabase-dart', + }, ], }, // { @@ -41,7 +45,7 @@ const sidebars = { label: 'Self hosted', collapsed: false, items: [ - { type: 'link', label: 'Auth Server', href: '/gotrue' }, + { type: 'link', label: 'Auth Server', href: '/auth' }, { type: 'link', label: 'Storage Server', href: '/storage' }, ], }, diff --git a/apps/reference/nav/api_sidebars.js b/apps/reference/nav/api_sidebars.js index 5653765980d..c1c9ee8400c 100644 --- a/apps/reference/nav/api_sidebars.js +++ b/apps/reference/nav/api_sidebars.js @@ -16,25 +16,7 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], - apiSidebar: [ - { - type: 'category', - label: 'Supabase API', - // collapsible: false, - // link: { - // type: 'doc', - // id: 'intro', - // }, - items: ['intro', 'usage', 'release-notes'], - }, - // 'intro', - - // { - // type: "category", - // label: "Release Notes", - // items: ["release-notes"], - // }, - ], + sidebar: ['intro', 'usage', 'release-notes'], } module.exports = sidebars diff --git a/apps/reference/nav/cli_sidebars.js b/apps/reference/nav/cli_sidebars.js index a3ec8651e93..4180ec512a4 100644 --- a/apps/reference/nav/cli_sidebars.js +++ b/apps/reference/nav/cli_sidebars.js @@ -16,7 +16,7 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], - cliSidebar: [ + sidebar: [ 'intro', 'usage', 'config', diff --git a/apps/reference/nav/gotrue_sidebars.js b/apps/reference/nav/gotrue_sidebars.js index 6a7ac837e65..6a1cfc804a8 100644 --- a/apps/reference/nav/gotrue_sidebars.js +++ b/apps/reference/nav/gotrue_sidebars.js @@ -16,7 +16,7 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - goTrueSidebar: [ + sidebar: [ 'intro', 'config', 'release-notes', diff --git a/apps/reference/nav/storage_sidebars.js b/apps/reference/nav/storage_sidebars.js index ae698831fe0..d7f8f4381f9 100644 --- a/apps/reference/nav/storage_sidebars.js +++ b/apps/reference/nav/storage_sidebars.js @@ -16,7 +16,7 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - storageSidebar: [ + sidebar: [ 'intro', 'usage', 'config', diff --git a/apps/reference/nav/supabase_dart_sidebars.js b/apps/reference/nav/supabase_dart_sidebars.js index fe0aadb2c11..84355614df5 100644 --- a/apps/reference/nav/supabase_dart_sidebars.js +++ b/apps/reference/nav/supabase_dart_sidebars.js @@ -16,16 +16,7 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - goTrueSidebar: [ - 'intro', - 'usage', - 'release-notes', - // { - // type: "category", - // label: "Release Notes", - // items: ["release-notes"], - // }, - ], + sidebar: ['intro', 'usage', 'release-notes'], } module.exports = sidebars diff --git a/apps/reference/nav/supabase_js_sidebars.js b/apps/reference/nav/supabase_js_sidebars.js index fe0aadb2c11..6560a74883b 100644 --- a/apps/reference/nav/supabase_js_sidebars.js +++ b/apps/reference/nav/supabase_js_sidebars.js @@ -16,7 +16,7 @@ const sidebars = { // By default, Docusaurus generates a sidebar from the docs folder structure // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}], - goTrueSidebar: [ + sidebar: [ 'intro', 'usage', 'release-notes', diff --git a/apps/reference/src/theme/DocSidebar/Desktop/Content/index.js b/apps/reference/src/theme/DocSidebar/Desktop/Content/index.js index 02cac10e226..7262050fb76 100644 --- a/apps/reference/src/theme/DocSidebar/Desktop/Content/index.js +++ b/apps/reference/src/theme/DocSidebar/Desktop/Content/index.js @@ -7,7 +7,7 @@ const subNavRoutes = [ // Add any routes which should have a subnav '/api', '/cli', - '/gotrue', + '/auth', '/storage', '/supabase-js', '/supabase-dart',