Import data

LiarOnce-LoongAL · Jul 10, 2024 · a4d8ab5 · a4d8ab5
1 parent 0149ecd
commit a4d8ab5
Show file tree

Hide file tree

Showing 13 changed files with 99 additions and 9 deletions.
diff --git a/docs/.vitepress/config_files/navbar.js b/docs/.vitepress/config_files/navbar.js
@@ -13,8 +13,14 @@ const navbar = [
         items: [
             { text: "硬件相关", link: "/hardwares/" },
             { text: "LAT 相关", link: "/lat/" },
-            { text: "LibLOL 相关", link: "/liblol" },
-            { text: "参与贡献", link: "/contribution" }
+            { text: "LibLOL 相关", link: "/liblol" }
+        ],
+    },
+    {
+        text: "参与贡献",
+        items: [
+            { text: "参与贡献", link: "/contribution/" },
+            { text: "常见问题", link: "/contribution/knownissues" }
         ],
     },
 ]

diff --git a/docs/contribution/index.md b/docs/contribution/index.md
@@ -42,7 +42,7 @@ link:   #链接
 | 无线网卡             | 对外的公开硬件名称，若为 PCIe 接口需在此标明 `(PCIe)`，若为 USB 接口需在此标明 `(USB)`。                                                                                                   |
 | 固态硬盘(SATA)       | 厂商对该硬件的对外宣传型号，例如 `SC001 Active`。                                                                                                                                            |
 | 固态硬盘(NVMe)       | 厂商对该硬件的对外宣传型号，例如 `SN750 `。                                                                                                                                                  |
-| 机械硬盘(SATA)       | 厂商对该硬件的对外宣传型号，例如 `ST4000DM004`。                                                                                                                                             |
+| 机械硬盘(SATA)       | 厂商对该硬件的对外宣传型号，例如 `ST4000DM004`，并在结尾加上硬盘容量 (`4TB`)。                                                                                                             |
 | 其他存储类设备(SATA) | 厂商对该硬件的对外宣传型号，例如 `BC-12D2HT`                                                                                                                                                 |
 | 键盘                 | 厂商对该硬件的对外宣传型号。                                                                                                                                                                   |
 | 鼠标                 | 厂商对该硬件的对外宣传型号。                                                                                                                                                                   |
@@ -138,17 +138,19 @@ link:   #链接
 
 若该硬件需要正式文档以说明兼容情况，请在 `/docs/hardwares/` 下存放 Markdown 文件。
 
-该值的填写格式如下（**请注意文件名不能使用中文，请使用全英文**）：
+对于硬件，我们建议使用其在 Linux 下的内核模块的名称来命名，例如现代 Intel 无线卡，则命名为 `iwlwifi.md`。
+
+然后该值的填写格式如下（**请注意文件名不能使用中文，请使用全英文**）。
 
 ```yaml
 /hardwares/<所写的markdown文件名>
 ```
 
-之后根据此处的指示将文档展示在指定位置。
+之后根据[此处](#external-docs)的指示将文档展示在指定位置。
 
 ### 最后的文件命名和存放位置
 
-对于文件命名，请参考以下表格：
+对于文件命名和存放位置，请参考以下表格：
 
 | 硬件类型             | 命名方式                                                                                                                                                                                            | 存放位置         |
 | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------- |
@@ -246,7 +248,7 @@ link:   #链接
 /lat/<所写的markdown文件名>
 ```
 
-之后根据此处的指示将文档展示在指定位置。
+之后根据[此处](#external-docs)的指示将文档展示在指定位置。
 
 ## LibLOL
 
@@ -310,4 +312,16 @@ link:   #链接
 /liblol/<所写的markdown文件名>
 ```
 
-之后根据此处的指示将文档展示在指定位置。
+之后根据[此处](#external-docs)的指示将文档展示在指定位置。
+
+## 额外内容
+
+若硬件或软件需要正式文档以说明兼容情况，请根据以下内容修改文件：
+
+首先请根据类型到 `/docs/.vitepress/config_files/sidebar_<hardwares/lat/liblol>.js` 下填写链接地址和文档标题，范例如下：
+
+```js
+{ text: '<文档标题>', link: '<文档地址>' }
+```
+
+其中 `link` 的值与 `.yml` 文件下的 `link` 相同。
diff --git a/docs/contribution/knownissues.md b/docs/contribution/knownissues.md
@@ -0,0 +1,14 @@
+---
+layout: doc
+sidebar: false
+outline: 'deep'
+---
+# 常见问题
+
+## 硬件
+
+### 为什么没有部分硬件类型 {#why-are-some-hardware-types-not-available}
+
+如果你所需要提交的硬件不包含在已知类型中，若为 USB 接口或 PCIe 接口的，请先归类到相应的类型后提交，若非这两种接口，则可以提出 issue 经过讨论后加入。
+
+对于类型为机械硬盘的硬件，请注意我们不会接受 SAS 接口的机械硬盘的数据，因为目前龙芯平台并未提供 SAS 接口的主板，并且我们认为 SAS 接口硬盘的支持应该取决于磁盘阵列卡和 HBA 卡而不是平台本身。
diff --git a/docs/data/hardwares/Gamepad/8bitdo-sn30pro-xbox.yml b/docs/data/hardwares/Gamepad/8bitdo-sn30pro-xbox.yml
@@ -0,0 +1,6 @@
+model: SN30 Pro for Android #型号
+brand: 8BitDo #品牌
+type: Gamepad  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容 3=新世界可用
+notes:  #备注
+link:   #链接
diff --git a/docs/data/hardwares/Gamepad/8bitdo-ultimate-2.4g.yml b/docs/data/hardwares/Gamepad/8bitdo-ultimate-2.4g.yml
@@ -0,0 +1,6 @@
+model: Ultimate 2.4G wireless Controller #型号
+brand: 8BitDo #品牌
+type: Gamepad  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容 3=新世界可用
+notes: 猎户座 2.4G 无线手柄 #备注
+link:   #链接
diff --git a/docs/data/hardwares/HDD_SATA/WD43PURZ.yml b/docs/data/hardwares/HDD_SATA/WD43PURZ.yml
@@ -0,0 +1,6 @@
+model: WD43PURZ (4TB) #型号
+brand: Western Digital #品牌
+type: HDD_SATA  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容 3=新世界可用
+notes:  #备注
+link:   #链接
diff --git a/docs/data/hardwares/Keyboard/akko-3108ds.yml b/docs/data/hardwares/Keyboard/akko-3108ds.yml
@@ -0,0 +1,6 @@
+model: 3087V2 #型号
+brand: Akko #品牌
+type: Keyboard  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容 3=新世界可用
+notes:  #备注
+link:   #链接
diff --git a/docs/data/hardwares/Mouse/mi-wireless-lite2.yml b/docs/data/hardwares/Mouse/mi-wireless-lite2.yml
@@ -0,0 +1,6 @@
+model: 小米无线鼠标 Lite 2 #型号
+brand: Xiaomi #品牌
+type: Mouse  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容 3=新世界可用
+notes:  #备注
+link:   #链接
diff --git a/docs/data/hardwares/Printer_AIO/dcpt425w.yml b/docs/data/hardwares/Printer_AIO/dcpt425w.yml
@@ -0,0 +1,6 @@
+model: DCP-T425W #型号
+brand: Brother #品牌
+type: Printer_AIO  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容 3=新世界可用
+notes: 使用 Wi-Fi 无线连接可以免驱动 #备注
+link:   #链接
diff --git a/docs/data/hardwares/Storage_SATA/bc-12d2ht.yml b/docs/data/hardwares/Storage_SATA/bc-12d2ht.yml
@@ -0,0 +1,6 @@
+model: BC-12D2HT #型号
+brand: ASUS #品牌
+type: Storage_SATA  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容
+notes: 光驱 #备注
+link:   #链接
diff --git a/docs/data/hardwares/Storage_SATA/drw-24d5mt.yml b/docs/data/hardwares/Storage_SATA/drw-24d5mt.yml
@@ -0,0 +1,6 @@
+model: DRW-24D5MT #型号
+brand: ASUS #品牌
+type: Storage_SATA  #类型
+status: 1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容
+notes: 光驱 #备注
+link:   #链接
diff --git a/docs/data/hardwares/Wireless/9461ac-9462ac.yml b/docs/data/hardwares/Wireless/9461ac-9462ac.yml
@@ -0,0 +1,6 @@
+model: Wireless AC 9461 / 9462 #型号
+brand: Intel #品牌
+type: Wireless  #类型
+status: -1  #兼容状态 -1=不兼容 0=未知 1=兼容  2=有限兼容 3=新世界可用
+notes:  #备注
+link: /hardwares/iwlwifi.html#cnvi  #链接
diff --git a/docs/hardwares/index.md b/docs/hardwares/index.md
@@ -5,4 +5,6 @@ aside: false
 prev: false
 next: false
 ---
-# 硬件相关
+# 硬件相关
+
+在左侧查看相关硬件的文档。