GeneralUpdate-Samples/website/sidebars.js at 4d0bb28bc2b02515380523c02290d853d824eb32 · GeneralLibrary/GeneralUpdate-Samples · 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
/**
 * @ts-check
 *
 * GeneralUpdate documentation sidebar.
 *
 * Pages are grouped by role:
 *   1. Quick Start & Cookbooks    — first-time user flow and advanced production guides
 *   2. Components                 — non-firmware component reference (Core, Bowl,
 *                                   Differential, Drivelution, Extension)
 *   3. Tools                      — GeneralUpdate.Tools usage and artifact reference
 *   4. Infrastructure             — server-side services (Spacestation, Hub)
 *   5. OSS Update Mode            — OSS-based update flows (.NET & MAUI)
 *   6. Utilities                  — shared helpers (GeneralTracer)
 *   7. Guides                     — operational / platform-specific guides
 *   8. Release Log                — changelog and roadmap
 */

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  tutorialSidebar: [
    // ── 1. Quick Start & Cookbooks ──────────────────────────────────
    {
      type: 'category',
      label: 'Quick Start',
      collapsed: false,
      items: [
        'quickstart/Quik start',
        'quickstart/Sample UI',
        'quickstart/Beginner cookbook',
      ],
    },
    {
      type: 'category',
      label: 'Advanced Cookbook',
      collapsed: true,
      items: [
        'quickstart/Advanced cookbook',
      ],
    },

    // ── 2. Components (non-firmware) ────────────────────────────────
    {
      type: 'category',
      label: 'Components',
      collapsed: false,
      items: [
        'doc/Component Introduction',
        'doc/GeneralUpdate.Core',
        'doc/GeneralUpdate.Bowl',
        'doc/GeneralUpdate.Differential',
        'doc/GeneralUpdate.Drivelution',
        'doc/GeneralUpdate.Extension',
        'doc/Android auto-update',
      ],
    },

    // ── 3. GeneralUpdate.Tools ──────────────────────────────────────
    {
      type: 'category',
      label: 'Tools',
      collapsed: true,
      items: [
        'doc/GeneralUpdate.PacketTool',
      ],
    },

    // ── 4. Infrastructure ───────────────────────────────────────────
    {
      type: 'category',
      label: 'Infrastructure',
      collapsed: true,
      items: [
        'doc/GeneralSpacestation',
      ],
    },

    // ── 5. OSS Update Mode ──────────────────────────────────────────
    {
      type: 'category',
      label: 'OSS Update Mode',
      collapsed: true,
      items: [
        'doc/GeneralClient.OSS',
        'doc/GeneralUpdate.Maui.OSS',
      ],
    },

    // ── 6. Utilities ────────────────────────────────────────────────
    {
      type: 'category',
      label: 'Utilities',
      collapsed: true,
      items: [
        'doc/GeneralTracer',
      ],
    },

    // ── 7. Guides ───────────────────────────────────────────────────
    {
      type: 'category',
      label: 'Guides',
      collapsed: true,
      items: [
        { type: 'autogenerated', dirName: 'guide' },
      ],
    },

    // ── 8. Release Log ──────────────────────────────────────────────
    {
      type: 'category',
      label: 'Release Log',
      collapsed: true,
      items: [
        'releaselog/GeneralUpdateReleaselog',
      ],
    },
  ],
};

export default sidebars;