summaryrefslogtreecommitdiff
path: root/web/sidebars.js
blob: 3863f6a40057247e45dc308c2c66bce558430801 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
/**
 * 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 = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  //tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],

  // But you can create a sidebar manually
  
  artiSidebar: [
    {
      type: 'doc',
      label: 'Getting Started with Arti',
      id: 'getting-started'
    },
    {
      type: 'category',
      label: 'Guides',
      items: ['guides/guides','guides/compiling-arti', 'guides/safer-build-options', 'guides/starting-arti', 'guides/configuring-arti', 'guides/connecting-to-onion', 'guides/troubleshooting', 'guides/compatibility', 'guides/capability-limitations', 'guides/cli-reference', 
    {
      "type": "link",
      "label": "Configuration Reference",
      "href": "https://tpo.pages.torproject.net/core/doc/rust/arti/index.html#configuration"
    }]
    },
    {
      type: 'category',
      label: 'Censorship',
      items: ['censorship/bridges', 'censorship/pluggable-transports']
    },
    {
      type: 'category',
      label: 'Integrating Arti',
      items: ['integrating-arti/integrating-arti',
        {
          type: 'category',
          label: 'Custom Wrappers',
          items: ['integrating-arti/custom-wrappers/iOS', 'integrating-arti/custom-wrappers/android']
        },
        'integrating-arti/using-tor', 'integrating-arti/examples',
      ]
    },
    {
      type: 'category',
      label: 'Contributing to Arti',
      items: [
        'contributing/contributing', 'contributing/code-of-conduct', 'contributing/support-policy',
        {
          type: 'category',
          label: 'For Developers',
          items: ['contributing/for-developers/project-status', 'contributing/for-developers/architecture', 'contributing/for-developers/config-options','contributing/for-developers/crates', 'contributing/for-developers/exposing-api', 'contributing/for-developers/testing', 'contributing/for-developers/logging']
        }
      ]
    },
    {
      type: 'link',
      label: 'Changelog',
      href: 'https://gitlab.torproject.org/tpo/core/arti/-/blob/main/CHANGELOG.md'
    },
    {
      type: 'link',
      label: 'Arti Rustdoc',
      href: 'https://tpo.pages.torproject.net/core/doc/rust/arti_client/index.html'
    },
    {
      type: 'link',
      label: 'Arti Coverage Reports',
      href: 'https://tpo.pages.torproject.net/core/arti/coverage/'
    },
    {
      type: 'category',
      label: 'Resources',
      items: [
        {
          type: 'link',
          label: 'Glossary',
          href: 'https://spec.torproject.org/glossary.html'
        },
        {
          type: 'link',
          label: 'Tor Specifications',
          href: 'https://spec.torproject.org'
        } 
      ]
    }
  ]
};

module.exports = sidebars;