docs.buttplug.io/sidebars.js at master · buttplugio/docs.buttplug.io · GitHub

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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
/**
 * 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 = {
  devGuideSidebar: [
    "dev-guide/index",
    "dev-guide/foreword",
    {
      type: "doc",
      label: "Quick Start",
      id: "dev-guide/getting-started",
    },
    {
      type: "category",
      label: "Flared Basics",
      items: [
        "dev-guide/intro/introduction",
        "dev-guide/intro/how-to-read",
        "dev-guide/intro/buttplug-ethics",
        "dev-guide/intro/getting-help",
      ],
    },
    {
      type: "category",
      label: "Strategies Against Buttplug Architecture",
      items: [
        "dev-guide/architecture/intro",
        "dev-guide/architecture/sessions-and-components",
        "dev-guide/architecture/protocol-in-depth",
        "dev-guide/architecture/client-in-depth",
        "dev-guide/architecture/client-device-in-depth",
        "dev-guide/architecture/server-in-depth",
        "dev-guide/architecture/intiface",
        "dev-guide/architecture/terms",
      ],
    },
    {
      type: "category",
      label: "Sticking Buttplug In",
      items: [
        "dev-guide/writing-buttplug-applications/intro",
        "dev-guide/writing-buttplug-applications/api-basics",
        "dev-guide/writing-buttplug-applications/connectors",
        "dev-guide/writing-buttplug-applications/connecting",
        "dev-guide/writing-buttplug-applications/device-enum",
        "dev-guide/writing-buttplug-applications/device-info",
        "dev-guide/writing-buttplug-applications/device-control",
        "dev-guide/writing-buttplug-applications/application",
      ],
    },
    {
      type: "category",
      label: "Winning Ways for Your Buttplug Plays",
      items: [
        "dev-guide/cookbook/intro",
        {
          type: "category",
          label: "Buttplug Connectors, Connections, and Engines",
          items: [
            "dev-guide/cookbook/connections/embedding",
            "dev-guide/cookbook/connections/ping",
          ],
        },
        {
          type: "category",
          label: "Devices and Commands",
          items: [
            "dev-guide/cookbook/devices-and-commands/intro",
            "dev-guide/cookbook/devices-and-commands/device-configurations",
          ],
        },
        {
          type: "category",
          label: "Integrating Buttplug in Games",
          items: [
            "dev-guide/cookbook/games/intro",
            "dev-guide/cookbook/games/unity",
            "dev-guide/cookbook/games/unreal",
            "dev-guide/cookbook/games/modding",
          ],
        },
        "dev-guide/cookbook/logging",
        "dev-guide/cookbook/privacy-models",
      ],
    },
    {
      type: "category",
      label: "Implementing new Devices and Clients",
      items: [
        "dev-guide/inflating-buttplug/intro",
        {
          type: "category",
          label: "Adding and Customizing Devices",
          items: [
            "dev-guide/inflating-buttplug/devices/intro",
            "dev-guide/inflating-buttplug/devices/device-configuration-file",
            "dev-guide/inflating-buttplug/devices/websocket-device-manager",
            "dev-guide/inflating-buttplug/devices/adding-device-protocols",
            "dev-guide/inflating-buttplug/devices/adding-device-comm-managers",
          ],
        },
      ],
    },
    {
      type: "category",
      label: "Appendices",
      items: ["dev-guide/appendices/history-of-buttplug"],
    }
  ],
  specSidebar: [
    "spec/index",
    "spec/changelog",
    "spec/architecture",
    "spec/messages",
    "spec/status",
    "spec/identification",
    "spec/device_discovery",
    "spec/device_information",
    "spec/stop",
    "spec/output",
    "spec/input",
    "spec/deprecated",
  ],
};

module.exports = sidebars;