Update page layout

siderakb · Jan 27, 2024 · 8bb5bf0 · 8bb5bf0
1 parent d453919
commit 8bb5bf0
Show file tree

Hide file tree

Showing 10 changed files with 131 additions and 71 deletions.
diff --git a/docs/ergosnm/_category_.json b/docs/ergosnm/_category_.json
diff --git a/docs/ergosnm/intro.md b/docs/ergosnm/intro.md
@@ -2,11 +2,17 @@
 sidebar_position: 0
 ---
 
-# Intro
+# ErgoSNM
 
-Welcome to the ***ErgoSNM Keyboard*** docs!
+![](https://imgur.com/hzSMu2A.jpg)
 
-- [Latest release](https://github.com/siderakb/ergo-snm-keyboard/releases/latest)
-- [GitHub repo](https://github.com/siderakb/ergo-snm-keyboard)
-- [Vial-QMK firmware](https://github.com/siderakb/vial-qmk/tree/siderakb/main/keyboards/siderakb/ergosnm) (*siderakb/main* branch).
+A split ergonomic keyboard with trackball.
+
+- GitHub repo
+  - [Hardware](https://github.com/siderakb/ergo-snm-keyboard)
+  - [Vial-QMK firmware](https://github.com/siderakb/vial-qmk/tree/siderakb/main/keyboards/siderakb/ergosnm) (*siderakb/main* branch).
 - [YouTube playlist](https://youtube.com/playlist?list=PL1kBTdTo-vGbdUH9_YovZvkGXuNMB03fa)
+
+import DocCardList from '@theme/DocCardList';
+
+<DocCardList />
diff --git a/docs/ergosnm/rev1.md b/docs/ergosnm/rev1.md
@@ -2,7 +2,7 @@
 sidebar_position: 2
 ---
 
-# Rev 1.x
+# ErgoSNM Rev 1.x
 
 :::caution
 `Rev 1.x` is an experimental version, NOT recommended for daily use.

diff --git a/docs/ergosnm/rev2.md b/docs/ergosnm/rev2.md
@@ -2,7 +2,7 @@
 sidebar_position: 1
 ---
 
-# Rev 2.x
+# ErgoSNM Rev 2.x
 
 ![](https://i.imgur.com/tddlJ7A.jpg)
 
@@ -223,6 +223,8 @@ For ErgoSNM `v2.1`, ref to PMW3360 PCB `V3.1`:
 
 ## Build Guide
 
+<iframe width="560" height="315" src="https://www.youtube.com/embed/1BXKdrCFn6c?si=3hTZfduKW4ZxY-fo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
+
 Steps summary:
 1. [Prepare parts](#prepare-parts)
 1. [Solder](#solder)
@@ -232,8 +234,6 @@ Steps summary:
 1. [Edit keymap](#edit-keymap)
 1. [Complete](#complete)
 
-Video: [ErgoSNM Rev2.1 Soldering and Assembly](https://youtu.be/1BXKdrCFn6c)
-
 :::info
 Before you start, make sure the parts are available, PMW3360 and BTUs are more difficult parts to buy.
 

diff --git a/docs/general-guide/_category_.json b/docs/general-guide/_category_.json
diff --git a/docs/intro.md b/docs/intro.md
@@ -8,26 +8,22 @@ Welcome to the **SideraKB** docs!
 
 ## Keyboards
 
-- [ErgoSNM](/docs/category/ergosnm): A split ergonomic keyboard with trackball.
-- [Calcite](https://github.com/siderakb/calcite): 60/52 keys ortho Choc low profile switch keyboard.
-- [Miniboard](https://github.com/siderakb/miniboard)🧪: A super mini keyboard.
-- [Keypad](https://github.com/siderakb/keypad)🧪: Some macropads.
+See [keyboard list](./keyboard-list).
+
 ## Development Boards
 
-| Name                                                 | I/O Pins | MCU                                                                                  | CPU                             | Flash            | SRAM  |
-|------------------------------------------------------|:--------:|--------------------------------------------------------------------------------------|---------------------------------|------------------|-------|
-| [RP Micro](https://github.com/siderakb/rp-micro)     |    25    | [RP2040](https://www.raspberrypi.com/products/rp2040/specifications/)                | 133MHz Dual-core ARM Cortex-M0+ | 8MB (External, 16MB Max)     | 264KB |
-| [Next μ](https://github.com/siderakb/next-micro)     |    25    | [ATmega32U4](https://www.microchip.com/en-us/product/atmega32u4)                     | 16MHz 8-bit AVR                 | 32KB +1KB EEPROM | 2.5KB |
-| [MDBTMicro](https://github.com/siderakb/mdbt-micro)🧪 |    25    | [nRF52840](https://www.nordicsemi.com/products/nrf52840) (MDBT50Q)                   | 64MHz  ARM Cortex-M4            | 1MB              | 256KB |
-| [Sphale](https://github.com/siderakb/sphale)🧪        |    23    | [STM32F303](https://www.st.com/en/microcontrollers-microprocessors/stm32f303cc.html) | 72MHz  ARM Cortex-M4            | 256KB            | 40KB  |
+| Name                                                | I/O Pins | MCU                                                                                  | CPU                             | Flash                    | SRAM  |
+| --------------------------------------------------- | :------: | ------------------------------------------------------------------------------------ | ------------------------------- | ------------------------ | ----- |
+| [RP Micro](https://github.com/siderakb/rp-micro)    |    25    | [RP2040](https://www.raspberrypi.com/products/rp2040/specifications/)                | 133MHz Dual-core ARM Cortex-M0+ | 8MB (External, 16MB Max) | 264KB |
+| [Next μ](https://github.com/siderakb/next-micro)    |    25    | [ATmega32U4](https://www.microchip.com/en-us/product/atmega32u4)                     | 16MHz 8-bit AVR                 | 32KB +1KB EEPROM         | 2.5KB |
+| [MDBTMicro](https://github.com/siderakb/mdbt-micro) |    25    | [nRF52840](https://www.nordicsemi.com/products/nrf52840) (MDBT50Q)                   | 64MHz  ARM Cortex-M4            | 1MB                      | 256KB |
+| [Sphale](https://github.com/siderakb/sphale)        |    23    | [STM32F303](https://www.st.com/en/microcontrollers-microprocessors/stm32f303cc.html) | 72MHz  ARM Cortex-M4            | 256KB                    | 40KB  |
 
 > All board sizes are 17.78×33.02 mm (0.7×1.3 inch), same as Pro Micro.
 
 ## Others
 
 - [PMW3360 PCB](https://github.com/siderakb/pmw3360-pcb): PMW3360DM-T2QU optical mouse sensor breakout board.
+- [PMW3610 PCB](https://github.com/siderakb/pmw3610-pcb): PMW3610DB-SUDU low power laser mouse sensor breakout board.
 - [key-switches.pretty](https://github.com/siderakb/key-switches.pretty): Mechanical keyboard switches KiCad footprint library.
 
----
-
-🧪: Experimental project.
diff --git a/docs/keyboard-list.md b/docs/keyboard-list.md
@@ -0,0 +1,19 @@
+# Keyboards
+
+|        Keyboard         |                          Image                           | Switches                                        | Note                 |
+| :---------------------: | :------------------------------------------------------: | :---------------------------------------------- | :------------------- |
+| [ErgoSNM v2.1][es_2.1]  |  <img src="https://imgur.com/hzSMu2A.jpg" width="420"/>  | 64 keys <br /> Cherry MX <br /> Hot-swap        | Trackball            |
+| [Calcite52 v1.0][c52_1] |  <img src="https://imgur.com/0LeJ65r.jpg" width="420"/>  | 52 keys <br /> Kailh Choc v1 <br /> Low profile |                      |
+| [Calcite60 v2.0][c60_2] |  <img src="https://imgur.com/EM8KTTF.jpg" width="420"/>  | 60 keys <br /> Kailh Choc v1 <br /> Low profile |                      |
+|    [Facade60][f60_1]    |                            🚧                             | 65 keys 60% <br /> Cherry MX <br /> Hot-swap    |                      |
+|      [MS60][m60_1]      |                            🚧                             | 68 keys 60% <br /> Cherry MX <br /> Hot-swap    |                      |
+| [Minicoard v2.0][mb_2]  |  <img src="https://imgur.com/G7iRKOk.jpg" width="420"/>  | 42 keys <br /> HYP 1TS015A  <br />  Tactile     | 50 ×18 mm super mini |
+|  [KP08Hub v1.0][kp_1]   | <img src="https://i.imgur.com/aPwjnLT.png" width="420"/> | 8 keys <br /> Cherry MX <br /> Low profile      |                      |
+
+[es_2.1]: /docs/ergosnm/rev2
+[c52_1]: https://github.com/siderakb/calcite/tree/main/Calcite52
+[c60_2]: https://github.com/siderakb/calcite/tree/main/Calcite60
+[f60_1]: https://github.com/siderakb/facade
+[m60_1]: https://github.com/siderakb/ms60
+[mb_2]: https://github.com/siderakb/miniboard/tree/main/rev2
+[kp_1]: https://github.com/siderakb/Keypad
diff --git a/docs/rp-micro.md b/docs/rp-micro.md
diff --git a/docusaurus.config.js b/docusaurus.config.js
@@ -61,6 +61,11 @@ const config = {
   themeConfig:
     /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
     ({
+      docs: {
+        sidebar: {
+          autoCollapseCategories: true, // https://docusaurus.io/docs/sidebar#auto-collapse-sidebar-categories
+        }
+      },
       colorMode: {
         defaultMode: 'dark'
       },
@@ -75,11 +80,17 @@ const config = {
         items: [
           {
             type: 'docSidebar',
-            sidebarId: 'tutorialSidebar',
+            sidebarId: 'docsSidebar',
             position: 'left',
             label: 'Docs',
           },
-          {to: '/docs/ergosnm/rev2', label: 'ErgoSNM', position: 'left'},
+          {
+            type: 'docSidebar',
+            sidebarId: 'keyboardSidebar',
+            position: 'left',
+            label: 'Keyboards',
+          },
+          { to: '/docs/ergosnm/rev2', label: 'ErgoSNM', position: 'left' },
           {
             href: 'https://github.com/siderakb',
             label: 'GitHub',

diff --git a/sidebars.js b/sidebars.js
@@ -14,18 +14,83 @@
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const sidebars = {
   // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
+  // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
 
   // But you can create a sidebar manually
-  // tutorialSidebar: [
-  //   'intro',
-  //   'hello',
-  //   {
-  //     type: 'category',
-  //     label: 'Tutorial',
-  //     items: ['tutorial-basics/create-a-document'],
-  //   },
-  // ],
+  docsSidebar: [
+    'intro',
+    // {
+    //   type: 'category',
+    //   label: 'Development Boards',
+    //   link: { type: 'generated-index', },
+    //   items: [
+    //     'rp-micro',
+    //   ],
+    // },
+    {
+      type: 'category',
+      label: 'General Guide',
+      link: { type: 'generated-index', },
+      items: [
+        'general-guide/dfu',
+        'general-guide/soldering',
+      ],
+    },
+    'how-to-get',
+    'research',
+  ],
+  keyboardSidebar: [
+    {
+      type: 'doc',
+      label: 'List',
+      id: 'keyboard-list',
+    },
+    {
+      type: 'category',
+      label: 'ErgoSNM',
+      link: {
+        type: 'doc',
+        id: 'ergosnm/intro'
+      },
+      items: [
+        {
+          type: 'doc',
+          label: 'Rev 2.x',
+          id: 'ergosnm/rev2',
+        },
+        {
+          type: 'doc',
+          label: 'Rev 1.x',
+          id: 'ergosnm/rev1',
+        },
+      ],
+    },
+    {
+      type: 'link',
+      label: 'Calcite',
+      href: 'https://github.com/siderakb/calcite',
+    },
+    {
+      type: 'link',
+      label: 'Facade',
+      href: 'https://github.com/siderakb/facade',
+    },
+    {
+      type: 'link',
+      label: 'MS60',
+      href: 'https://github.com/siderakb/ms60',
+    },
+    {
+      type: 'link',
+      label: 'Miniboard',
+      href: 'https://github.com/siderakb/miniboard',
+    },
+    {
+      type: 'link',
+      label: 'Keypad',
+      href: 'https://github.com/siderakb/Keypad',
+    },
+  ],
 };
 
 module.exports = sidebars;