Detox/website/sidebars.js

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  tutorialSidebar: [
    {
      type: 'category',
      label: 'Introduction',
      items: [
        'introduction/getting-started',
        'introduction/environment-setup',
        'introduction/project-setup',
        'introduction/your-first-test',
        'introduction/debugging',
        'introduction/preparing-for-ci',
      ]
    },
    {
      type: 'category',
      label: 'Guides',
      items: [
        'guide/test-id',
        'guide/parallel-test-execution',
        'guide/detox-repl',
        'guide/typescript',
        'guide/testing-webviews',
        'guide/genymotion-saas',
        'guide/taking-screenshots',
        'guide/mocking',
        'guide/launch-args',
        'guide/mocking-open-with-url',
        'guide/mocking-user-notifications',
        'guide/mocking-user-activity',
        'guide/developing-while-writing-tests',
        'guide/android-dev-env',
        'guide/proguard-configuration',
        'guide/cucumber-js-integration',
        'guide/uninstalling',
      ]
    },
    {
      type: 'category',
      label: 'Pilot-Powered Detox Testing',
      items: [
        'pilot/testing-with-pilot',
        'pilot/best-practices',
      ]
    },
    {
      type: 'category',
      label: 'Troubleshooting',
      items: [
        'troubleshooting/building-the-app',
        'troubleshooting/running-tests',
        'troubleshooting/synchronization',
        'troubleshooting/flakiness',
        'troubleshooting/element-matching',
      ]
    },
    {
      type: 'doc',
      id: 'guide/migration',
    }
  ],
  apiSidebar: [
    {
      type: 'category',
      label: 'Config file',
      items: [
        'config/overview',
        'config/devices',
        'config/apps',
        'config/artifacts',
        'config/behavior',
        'config/logger',
        'config/session',
        'config/testRunner',
      ]
    },
    {
      type: 'category',
      label: 'Command Line Interface',
      items: [
        'cli/overview',
        'cli/init',
        'cli/build',
        'cli/start',
        'cli/test',
        'cli/recorder',
        'cli/build-framework-cache',
        'cli/clean-framework-cache',
        'cli/rebuild-framework-cache',
        'cli/reset-lock-file',
        'cli/run-server',
      ]
    },
    {
      type: 'category',
      label: 'Client API',
      items: [
        'api/device',
        'api/matchers',
        'api/actions',
        'api/expect',
        'api/webviews',
        'api/system',
        'api/logger',
        'api/pilot',
      ]
    },
    'api/internals',
    {
      type: 'category',
      label: 'Tech Articles',
      items: [
        'articles/design-principles',
        'articles/how-detox-works',
        'articles/third-party-drivers',
      ]
    },
  ],
  contributeSidebar: [
    'contributing',
    {
      type: 'category',
      label: 'Questions & Answers',
      items: [
        'contributing/questions/asking-questions',
        'contributing/questions/answering-questions',
      ]
    },
    'contributing/reporting-bugs',
    'contributing/feature-requests',
    {
      type: 'category',
      label: 'Code Changes',
      items: [
        'contributing/code/overview',
        'contributing/code/setting-up-the-dev-environment',
        'contributing/code/building-and-testing',
        'contributing/code/example-projects',
        'contributing/code/submitting-pull-requests',
        'contributing/code/reviewing-pull-requests',
      ]
    },
    'contributing/documentation',
    'contributing/code-of-conduct'
  ],
};

module.exports = sidebars;