From d1416c856af5211090f2123f3f968ca649e12e8f Mon Sep 17 00:00:00 2001 From: Donggang Cao Date: Sat, 24 Oct 2020 21:26:23 +0800 Subject: [PATCH] renamed some dirs --- docs/.vuepress/config.js | 12 ++++----- docs/.vuepress/sidebar.js | 15 +++++------ docs/doc/README.md | 14 ++++++++++ docs/doc/appdev/README.md | 8 +++--- docs/doc/communication/README.md | 26 +++++++++---------- docs/doc/hwsupport/README.md | 17 ------------ docs/doc/kernel/README.md | 10 ++++--- docs/doc/processor/README.md | 19 ++++++++++++++ .../{hwsupport => processor}/aiit-arm32.md | 0 .../{hwsupport => processor}/aiit-arm64.md | 0 .../{hwsupport => processor}/hifive1-rev.md | 0 docs/doc/{hwsupport => processor}/kd233.md | 0 docs/doc/{hwsupport => processor}/maxgo.md | 0 .../stm32f407-st-discovery.md | 0 .../{hwsupport => processor}/stm32f407zgt6.md | 0 docs/doc/sensor/README.md | 18 +++++++------ 16 files changed, 80 insertions(+), 59 deletions(-) delete mode 100644 docs/doc/hwsupport/README.md create mode 100644 docs/doc/processor/README.md rename docs/doc/{hwsupport => processor}/aiit-arm32.md (100%) rename docs/doc/{hwsupport => processor}/aiit-arm64.md (100%) rename docs/doc/{hwsupport => processor}/hifive1-rev.md (100%) rename docs/doc/{hwsupport => processor}/kd233.md (100%) rename docs/doc/{hwsupport => processor}/maxgo.md (100%) rename docs/doc/{hwsupport => processor}/stm32f407-st-discovery.md (100%) rename docs/doc/{hwsupport => processor}/stm32f407zgt6.md (100%) diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 9c95f59..8447d28 100755 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -48,11 +48,11 @@ module.exports = { link: '/doc/kernel/', }, { - text: '硬件支持', - link: '/doc/hwsupport/', + text: '处理器', + link: '/doc/processor/', }, { - text: '通信协议', + text: '通信器', link: '/doc/communication/', }, { @@ -106,11 +106,11 @@ module.exports = { children: getSidebarByCategory('kernel','en') }, { - title: '硬件支持', - children: getSidebarByCategory('hwsupport','en') + title: '处理器', + children: getSidebarByCategory('processor','en') }, { - title: '通信协议', + title: '通信器', children: getSidebarByCategory('communication','en') }, { diff --git a/docs/.vuepress/sidebar.js b/docs/.vuepress/sidebar.js index f02be33..ff4cdd5 100755 --- a/docs/.vuepress/sidebar.js +++ b/docs/.vuepress/sidebar.js @@ -8,13 +8,13 @@ const sidebar = { '/doc/kernel/synchron', '/doc/kernel/threadcommunication' ], - 'hwsupport': [ - '/doc/hwsupport/aiit-arm32', - '/doc/hwsupport/stm32f407-st-discovery', - '/doc/hwsupport/stm32f407zgt6', - '/doc/hwsupport/hifive1-rev', - '/doc/hwsupport/maxgo', - '/doc/hwsupport/kd233' + 'processor': [ + '/doc/processor/aiit-arm32', + '/doc/processor/stm32f407-st-discovery', + '/doc/processor/stm32f407zgt6', + '/doc/processor/hifive1-rev', + '/doc/processor/maxgo', + '/doc/processor/kd233' ], 'communication': [ '/doc/communication/4G', @@ -24,7 +24,6 @@ const sidebar = { '/doc/communication/CAN', '/doc/communication/ethernet', '/doc/communication/LORA', - '/doc/communication/mymqtt', '/doc/communication/NB-IOT', '/doc/communication/rs485', '/doc/communication/WiFi', diff --git a/docs/doc/README.md b/docs/doc/README.md index 9ffa169..81fe9a6 100644 --- a/docs/doc/README.md +++ b/docs/doc/README.md @@ -1 +1,15 @@ # 文档中心 + +--- + +- [XiUOS简介](/doc/intro.md) + +- [内核](/doc/kernel) + +- [处理器](/doc/processor) + +- [通信器](/doc/communication) + +- [传感器](/doc/sensor) + +- [应用开发](/doc/appdev) diff --git a/docs/doc/appdev/README.md b/docs/doc/appdev/README.md index 1b3d011..ff90ed6 100644 --- a/docs/doc/appdev/README.md +++ b/docs/doc/appdev/README.md @@ -1,7 +1,9 @@ # 应用开发 -* [开发环境](/doc/appdev/env) +--- -* [调试工具](/doc/appdev/debug) +* [开发环境](/doc/appdev/env.md) -* [开发过程](/doc/appdev/dev) +* [调试工具](/doc/appdev/debug.md) + +* [开发过程](/doc/appdev/dev.md) diff --git a/docs/doc/communication/README.md b/docs/doc/communication/README.md index 34cd99f..c13dfa7 100644 --- a/docs/doc/communication/README.md +++ b/docs/doc/communication/README.md @@ -1,26 +1,26 @@ -# 通信协议 +# 通信器 -- [4G](/doc/communication/4G) +--- -- [5G](/doc/communication/5G) +- [4G](/doc/communication/4G.md) -- [at](/doc/communication/at) +- [5G](/doc/communication/5G.md) -- [Bluetooth](/doc/communication/Bluetooth) +- [at](/doc/communication/at.md) -- [CAN](/doc/communication/CAN) +- [Bluetooth](/doc/communication/Bluetooth.md) -- [Ethernet](/doc/communication/ethernet) +- [CAN](/doc/communication/CAN.md) -- [LoRa](/doc/communication/LORA) +- [Ethernet](/doc/communication/ethernet.md) -- [MQTT](/doc/communication/mymqtt) +- [LoRa](/doc/communication/LORA.md) -- [NB-IOT](/doc/communication/NB-IOT) +- [NB-IOT](/doc/communication/NB-IOT.md) -- [rs485](/doc/communication/rs485) +- [rs485](/doc/communication/rs485.md) -- [WiFi](/doc/communication/WiFi) +- [WiFi](/doc/communication/WiFi.md) -- [Zibgee](/doc/communication/Zigbee) +- [Zibgee](/doc/communication/Zigbee.md) diff --git a/docs/doc/hwsupport/README.md b/docs/doc/hwsupport/README.md deleted file mode 100644 index 56944e1..0000000 --- a/docs/doc/hwsupport/README.md +++ /dev/null @@ -1,17 +0,0 @@ -# 硬件支持 - -## ARM - -* [aiit-arm32](/doc/hwsupport/aiit-arm32) - -* [stm32f407-st-discovery](/doc/hwsupport/stm32f407-st-discovery) - -* [stm32f407zgt6](/doc/hwsupport/stm32f407zgt6) - -## RISC-V - -* [hifive1-re](/doc/hwsupport/hifive1-rev) - -* [maxgo](/doc/hwsupport/maxg) - -* [kd233](/doc/hwsupport/kd233) diff --git a/docs/doc/kernel/README.md b/docs/doc/kernel/README.md index 5423945..c64d2fb 100644 --- a/docs/doc/kernel/README.md +++ b/docs/doc/kernel/README.md @@ -1,10 +1,12 @@ # 内核 -- [内存管理](/doc/kernel/mm) +--- -- [线程管理](/doc/kernel/task) +- [内存管理](/doc/kernel/mm.md) -- [资源管理](/doc/kernel/synchron) +- [线程管理](/doc/kernel/task.md) -- [线程间通信](/doc/kernel/threadcommunication) +- [资源管理](/doc/kernel/synchron.md) + +- [线程间通信](/doc/kernel/threadcommunication.md) diff --git a/docs/doc/processor/README.md b/docs/doc/processor/README.md new file mode 100644 index 0000000..e1f8cfc --- /dev/null +++ b/docs/doc/processor/README.md @@ -0,0 +1,19 @@ +# 硬件支持 + +--- + +## ARM + +* [aiit-arm32](/doc/processor/aiit-arm32.md) + +* [stm32f407-st-discovery](/doc/processor/stm32f407-st-discovery.md) + +* [stm32f407zgt6](/doc/processor/stm32f407zgt6.md) + +## RISC-V + +* [hifive1-re](/doc/processor/hifive1-rev.md) + +* [maxgo](/doc/processor/maxg.md) + +* [kd233](/doc/processor/kd233.md) diff --git a/docs/doc/hwsupport/aiit-arm32.md b/docs/doc/processor/aiit-arm32.md similarity index 100% rename from docs/doc/hwsupport/aiit-arm32.md rename to docs/doc/processor/aiit-arm32.md diff --git a/docs/doc/hwsupport/aiit-arm64.md b/docs/doc/processor/aiit-arm64.md similarity index 100% rename from docs/doc/hwsupport/aiit-arm64.md rename to docs/doc/processor/aiit-arm64.md diff --git a/docs/doc/hwsupport/hifive1-rev.md b/docs/doc/processor/hifive1-rev.md similarity index 100% rename from docs/doc/hwsupport/hifive1-rev.md rename to docs/doc/processor/hifive1-rev.md diff --git a/docs/doc/hwsupport/kd233.md b/docs/doc/processor/kd233.md similarity index 100% rename from docs/doc/hwsupport/kd233.md rename to docs/doc/processor/kd233.md diff --git a/docs/doc/hwsupport/maxgo.md b/docs/doc/processor/maxgo.md similarity index 100% rename from docs/doc/hwsupport/maxgo.md rename to docs/doc/processor/maxgo.md diff --git a/docs/doc/hwsupport/stm32f407-st-discovery.md b/docs/doc/processor/stm32f407-st-discovery.md similarity index 100% rename from docs/doc/hwsupport/stm32f407-st-discovery.md rename to docs/doc/processor/stm32f407-st-discovery.md diff --git a/docs/doc/hwsupport/stm32f407zgt6.md b/docs/doc/processor/stm32f407zgt6.md similarity index 100% rename from docs/doc/hwsupport/stm32f407zgt6.md rename to docs/doc/processor/stm32f407zgt6.md diff --git a/docs/doc/sensor/README.md b/docs/doc/sensor/README.md index add11bf..54ebf0d 100644 --- a/docs/doc/sensor/README.md +++ b/docs/doc/sensor/README.md @@ -1,18 +1,20 @@ # 传感器 -- [力敏传感器](/doc/sensor/force_sensor) +--- -- [气敏传感器](/doc/sensor/gas_sensor) +- [力敏传感器](/doc/sensor/force_sensor.md) -- [热敏传感器](/doc/sensor/heat_sensor) +- [气敏传感器](/doc/sensor/gas_sensor.md) -- [湿敏传感器](/doc/sensor/humidity_sensor) +- [热敏传感器](/doc/sensor/heat_sensor.md) -- [磁敏传感器](/doc/sensor/magneto_sensor) +- [湿敏传感器](/doc/sensor/humidity_sensor.md) -- [光电传感器](/doc/sensor/photoelec_sensor) +- [磁敏传感器](/doc/sensor/magneto_sensor.md) -- [压强传感器](/doc/sensor/pressure_sensor) +- [光电传感器](/doc/sensor/photoelec_sensor.md) -- [声音传感器](/doc/sensor/voice_sensor) +- [压强传感器](/doc/sensor/pressure_sensor.md) + +- [声音传感器](/doc/sensor/voice_sensor.md)