humanoid-control-website/sidebars.ts at main · berkeley-humanoids/humanoid-control-website · 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
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';

// Five-section Diátaxis-derived layout
// (https://diataxis.fr/). The progression mirrors Isaac Lab / Nav2 /
// MoveIt 2: arrive → install → first lesson → more lessons → tasks →
// understand → look up.
//
// - Getting started : intro + install + the one canonical tutorial.
// - Tutorials       : learning-oriented. Build skill, no production realism.
// - How-to guides   : task-oriented recipes. Assume baseline familiarity.
// - Concepts        : understanding-oriented. The "why" layer.
// - Reference       : information-oriented. Dense, scannable, complete.
const sidebars: SidebarsConfig = {
  docs: [
    {
      type: 'category',
      label: 'Getting started',
      collapsed: false,
      items: [
        'getting_started/intro',
        'getting_started/installation',
        'getting_started/lite_101',
      ],
    },
    {
      type: 'category',
      label: 'Tutorials',
      collapsed: true,
      items: [
        'tutorials/index',
        'tutorials/drive_one_robstride',
        'tutorials/mujoco_fsm_walk',
        'tutorials/tracking_policy',
        'tutorials/run_gravity_compensation',
        'tutorials/build_your_own_controller',
      ],
    },
    {
      type: 'category',
      label: 'How-to guides',
      collapsed: true,
      items: [
        'how_to/index',
        'how_to/first_real_bringup',
        'how_to/calibrate_zero_pose',
        'how_to/calibrate_prime_erob',
        'how_to/probe_can_bus',
        'how_to/switch_controllers_manually',
        'how_to/mit_slider_gui',
        'how_to/live_viz',
        'how_to/record_experiments',
        'how_to/diagnose_enobufs',
        'how_to/recover_from_fault',
        'how_to/promote_python_to_cpp',
        'how_to/talk_to_humanoid_control_from_python',
        'how_to/add_new_joint',
        'how_to/use_pixi_tasks',
      ],
    },
    {
      type: 'category',
      label: 'Concepts',
      collapsed: true,
      items: [
        'concepts/index',
        'concepts/architecture',
        'concepts/workspace_and_environment',
        'concepts/five_mode_fsm',
        'concepts/mit_command_surface',
        'concepts/hardware_backend_selection',
        'concepts/prime_hybrid_actuation',
        'concepts/calibration_math',
        'concepts/safety_pipeline',
        'concepts/frozen_schemas',
      ],
    },
    {
      type: 'category',
      label: 'Reference',
      collapsed: true,
      items: [
        'reference/quick_reference',
        'reference/hardware_specs',
        'reference/packages',
        'reference/messages',
        'reference/controllers',
        'reference/manual_controllers',
        'reference/launch_args',
        'reference/policy_runner',
        'reference/topics_services',
        'reference/cli_tools',
        'reference/urdf_args',
        'reference/troubleshooting',
        'reference/reference_map',
      ],
    },
    {
      type: 'category',
      label: 'Extras',
      collapsed: true,
      items: [
        'extras/prime_bringup',
      ],
    },
  ],
};

export default sidebars;