objectbox-c-cpp-docs/sidebars.ts at main · objectbox/objectbox-c-cpp-docs · 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
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';

/**
 * 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.
 */
const sidebars: SidebarsConfig = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  // To achieve the desired structure, we define it manually.
  docs: [
    {
      type: 'doc',
      id: 'README',
      label: 'ObjectBox C / C++ Database', // Clean label
    },
    {
      type: 'doc',
      id: 'installation',
      label: 'Installation', // Clean label
    },
    {
      type: 'doc',
      id: 'getting-started',
      label: 'Getting Started', // Clean label
    },
    {
      type: 'doc',
      id: 'entity-annotations',
      label: 'Entity Annotations', // Clean label
    },
    {
      type: 'doc',
      id: 'generator',
      label: 'Generator', // Clean label
    },
    {
      type: 'doc',
      id: 'store',
      label: 'Store', // Clean label
    },
    {
      type: 'doc',
      id: 'queries',
      label: 'Queries', // Clean label
    },
    {
      type: 'doc',
      id: 'relations',
      label: 'Relations', // Clean label
    },
    {
      type: 'doc',
      id: 'transactions',
      label: 'Transactions', // Clean label
    },
    {
      type: 'doc',
      id: 'schema-changes',
      label: 'Schema Changes', // Clean label
    },
    {
      type: 'doc',
      id: 'time-series-data',
      label: 'Time Series Data', // Clean label
    },
    {
      type: 'doc',
      id: 'dev-tools-and-debugging',
      label: 'Dev Tools and Debugging', // Clean label
    },
    {
      type: 'doc',
      id: 'faq',
      label: 'FAQ', // Clean label
    },
    // --- External Links Section ---
    {
      type: 'html',
      value: '<hr class="sidebar-divider">', // Optional: Adds a visual separator
    },
    {
      type: 'link',
      label: 'GitHub',
      href: 'https://github.com/objectbox/objectbox-c',
    },
    {
      type: 'link',
      label: 'ObjectBox Generator',
      href: 'https://github.com/objectbox/objectbox-generator',
    },
    {
      type: 'link',
      label: 'C API docs',
      href: 'https://objectbox.io/docfiles/c/current/',
    },
    {
      type: 'html',
      value: '<hr class="sidebar-divider">', // Optional: Adds a visual separator
    },
    {
      type: 'link',
      label: 'Golang Database',
      href: 'https://golang.objectbox.io/',
    },
    {
      type: 'link',
      label: 'Swift Database',
      href: 'https://swift.objectbox.io/',
    },
    {
        type: 'link',
        label: 'Java Database',
        href: 'https://docs.objectbox.io/',
      },
  ],
};

export default sidebars;