supabase/web/sidebars.js

/**
 * Copyright (c) 2017-present, Facebook, Inc.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 */

const dartClient = require('./sidebar_spec_dart')
const goTrueClient = require('./sidebar_spec_gotrue')
const postgrestClient = require('./sidebar_spec_postgrest')
const realtimeClient = require('./sidebar_spec_realtime')
const supabaseClient = require('./sidebar_spec_supabase')
const supabaseCli = require('./sidebar_spec_cli')
const postgres = require('./sidebar_spec_postgres')

module.exports = {
  goTrueClient: [
    {
      type: 'category',
      label: 'Javascript',
      collapsed: false,
      items: goTrueClient.docs,
    },
  ],
  postgrestClient: [
    {
      type: 'category',
      label: 'Javascript',
      collapsed: false,
      items: postgrestClient.docs,
    },
  ],
  realtimeClient: [
    {
      type: 'category',
      label: 'Javascript',
      collapsed: false,
      items: realtimeClient.docs,
    },
  ],
  supabaseClient: [
    {
      type: 'category',
      label: 'Javascript',
      collapsed: false,
      items: supabaseClient.docs,
    },
    {
      type: 'category',
      label: 'Dart',
      collapsed: false,
      items: dartClient.docs,
    },
    {
      type: 'category',
      label: 'Postgres',
      collapsed: false,
      items: postgres.docs,
    },
    {
      type: 'category',
      label: 'CLI',
      collapsed: false,
      items: supabaseCli.docs,
    },
  ],
  docs: [
    {
      type: 'category',
      label: 'Introduction',
      items: ['about', 'faq'],
      collapsed: false,
    },
    {
      type: 'category',
      label: 'Getting Started',
      collapsed: false,
      items: [
        'guides/platform',
        'guides/database',
        'guides/auth',
        'guides/storage',
        'guides/api',
        'guides/client-libraries',
        'guides/local-development',
      ],
    },
    {
      type: 'category',
      label: 'Tutorials',
      collapsed: false,
      items: [
        'guides/examples',
        'guides/with-nextjs',
        'guides/with-react',
        'guides/with-svelte',
        'guides/with-vue-3',
        'guides/with-angular',
        'guides/self-hosting',
      ],
    },
    {
      type: 'category',
      label: 'See Also',
      collapsed: false,
      items: ['handbook/contributing', 'company/terms', 'company/privacy', 'company/aup'],
    },
  ],
  guides: [
    {
      type: 'category',
      label: 'Guides',
      items: ['guides'],
      collapsed: false,
    },
    {
      type: 'category',
      label: 'Database',
      collapsed: false,
      items: [
        'guides/database/full-text-search',
        // 'guides/database/arrays',
        // 'guides/database/json',
        // 'guides/database/managing-passwords',
        // 'guides/database/sql-to-api',
        {
          type: 'category',
          label: 'Extensions',
          collapsed: false,
          items: [
            'guides/database/extensions',
            // 'guides/database/extensions/pgtap',
            'guides/database/extensions/plv8',
            'guides/database/extensions/http',
            'guides/database/extensions/uuid-ossp',
          ],
        },
        {
          type: 'category',
          label: 'Connecting to Postgres',
          collapsed: false,
          items: [
            'guides/database/connecting/connecting-to-postgres',
            'guides/database/connecting/direct-connections',
            'guides/database/connecting/connection-pooling',
          ],
        },
      ],
    },
    {
      type: 'category',
      label: 'Auth',
      collapsed: false,
      items: [
        'guides/auth/managing-user-data',
        {
          type: 'category',
          label: 'OAuth Providers',
          collapsed: false,
          items: [
            'guides/auth/auth-apple',
            'guides/auth/auth-bitbucket',
            'guides/auth/auth-discord',
            'guides/auth/auth-facebook',
            'guides/auth/auth-github',
            'guides/auth/auth-gitlab',
            'guides/auth/auth-google',
            'guides/auth/auth-twitter',
          ],
        },
      ],
    },
    // {
    //   type: 'category',
    //   label: 'Storage',
    //   collapsed: false,
    //   items: ['guides/storage/storage-sample'],
    // },
  ],
  resources: [
    { type: 'category', label: 'Resources', items: ['resources'], collapsed: false },
    // { type: 'category', label: 'Resources', collapsed: false },
    {
      type: 'category',
      label: 'Learn',
      collapsed: false,
      items: [
        {
          type: 'category',
          label: 'Auth Deep Dive',
          collapsed: false,
          items: [
            'learn/auth-deep-dive/auth-deep-dive-jwts',
            'learn/auth-deep-dive/auth-row-level-security',
            'learn/auth-deep-dive/auth-policies',
            'learn/auth-deep-dive/auth-gotrue',
            'learn/auth-deep-dive/auth-google-oauth',
          ],
        },
      ],
    },
    {
      type: 'category',
      label: 'Tools',
      collapsed: false,
      items: [
        'gotrue/server/about',
        'gotrue/client/index',
        'postgrest/server/about',
        'postgrest/client/index',
        'realtime/server/about',
        'realtime/client/index',
      ],
    },
  ],
  // realtimeServer: [
  //   {
  //     type: 'category',
  //     label: 'Realtime',
  //     collapsed: false,
  //     items: ['realtime/server/about'],
  //   },
  //   {
  //     type: 'category',
  //     label: 'Self hosting',
  //     collapsed: false,
  //     items: [
  //       'realtime/server/docker',
  //       'realtime/server/aws',
  //       'realtime/server/digitalocean',
  //       'realtime/server/source',
  //     ],
  //   },
  // ],
  // realtimeClient: [
  //   {
  //     type: 'category',
  //     label: 'Realtime',
  //     collapsed: false,
  //     items: ['realtime/client/about'],
  //   },
  // ],
  // postgrestServer: [
  //   {
  //     type: 'category',
  //     label: 'PostgREST',
  //     collapsed: false,
  //     items: ['postgrest/server/about'],
  //   },
  // ],
  postgresServer: [
    {
      type: 'category',
      label: 'Postgres',
      collapsed: false,
      items: ['postgres/server/about'],
    },
    {
      type: 'category',
      label: 'Self hosting',
      collapsed: false,
      items: ['postgres/server/docker', 'postgres/server/aws', 'postgres/server/digitalocean'],
    },
  ],
  postgresApi: [
    {
      type: 'category',
      label: 'Postgres API',
      collapsed: false,
      items: ['postgres/api/about'],
    },
  ],
}