Skip to content

Commit a7668bb

Browse files
lijunru-hublijunru-hub
committed
docs: change old docs link
1 parent 7f6be2f commit a7668bb

File tree

36 files changed

+59
-55
lines changed

36 files changed

+59
-55
lines changed

‎README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Documentation Status](https://dl.espressif.com/AE/docs/docs_latest.svg)](https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/esp32/index.html)
1+
[![Documentation Status](https://dl.espressif.com/AE/docs/docs_latest.svg)](https://docs.espressif.com/projects/esp-iot-solution/en)
22

33
## Espressif IoT Solution Overview
44

@@ -14,8 +14,8 @@ ESP-IoT-Solution contains the following contents:
1414

1515
## Documentation Center
1616

17-
- 中文：https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN
18-
- English:https://docs.espressif.com/projects/espressif-esp-iot-solution/en
17+
- 中文：https://docs.espressif.com/projects/esp-iot-solution/zh_CN
18+
- English:https://docs.espressif.com/projects/esp-iot-solution/en
1919

2020
## Quick Reference
2121

@@ -35,7 +35,7 @@ Please note that different versions of ESP-IoT-Solution may depend on different
3535

3636
| ESP-IoT-Solution | Dependent ESP-IDF | Major Change | User Guide | Support State |
3737
| :--------------: | :---------------: | :-------------------------------------------------: | :----------------------------------------------------------------------------------------------------------: | --------------------------- |
38-
| master | >= v4.4 | support component manager and new chips | [Docs online](https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN) | active, new feature develop |
38+
| master | >= v4.4 | support component manager and new chips | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/zh_CN) | active, new feature develop |
3939
| release/v1.1 | v4.0.1 | IDF version update, remove no longer supported code | [v1.1 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.1#esp32-iot-solution-overview) | archived |
4040
| release/v1.0 | v3.2.2 | legacy version | [v1.0 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.0#esp32-iot-solution-overview) | archived |
4141

@@ -78,7 +78,7 @@ You can directly add the components from the Component Registry to your project
7878
7979
#### Get ESP-IoT-Solution Repository
8080

81-
If you want to [Contribute](https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/contribute/index.html) to the components in ESP-IoT-Solution or want to start from the examples in ESP-IoT-Solution, you can get the ESP-IoT-Solution repository by following the steps:
81+
If you want to [Contribute](https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/contribute/index.html) to the components in ESP-IoT-Solution or want to start from the examples in ESP-IoT-Solution, you can get the ESP-IoT-Solution repository by following the steps:
8282

8383
* If select the `master` version, open the terminal, and run the following command:
8484

@@ -107,9 +107,9 @@ There is no difference between building and flashing the examples in ESP-IoT-Sol
107107
108108
### Resources
109109
110-
- Documentation for the latest version: https://docs.espressif.com/projects/espressif-esp-iot-solution/ . This documentation is built from the [docs directory](./docs) of this repository.
110+
- Documentation for the latest version: https://docs.espressif.com/projects/esp-iot-solution/ . This documentation is built from the [docs directory](./docs) of this repository.
111111
- ESP-IDF Programming Guide: https://docs.espressif.com/projects/esp-idf/zh_CN . Please refer to the version ESP-IoT-Solution depends on.
112112
- The [IDF Component Registry](https://components.espressif.com/) is where you can find the components in ESP-IoT-Solution and other registered components.
113-
- The [esp32.com forum](https://esp32.com/) is a place to ask questions and find community resources.
113+
- The [esp32.com forum](https://www.esp32.com/) is a place to ask questions and find community resources.
114114
- [Check the Issues section on GitHub]((https://github.com/espressif/esp-iot-solution/issues)) if you find a bug or have a feature request. Please check existing Issues before opening a new one.
115115
- If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](./CONTRIBUTING.rst).

‎README_CN.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Documentation Status](https://dl.espressif.com/AE/docs/docs_latest.svg)](https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/esp32/index.html)
1+
[![Documentation Status](https://dl.espressif.com/AE/docs/docs_latest.svg)](https://docs.espressif.com/projects/esp-iot-solution/zh_CN)
22

33
## Espressif IoT Solution 概述
44

@@ -14,8 +14,8 @@ ESP-IoT-Solution 包含的内容如下:
1414

1515
## 文档中心
1616

17-
- 中文：https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN
18-
- English: https://docs.espressif.com/projects/espressif-esp-iot-solution/en
17+
- 中文：https://docs.espressif.com/projects/esp-iot-solution/zh_CN
18+
- English: https://docs.espressif.com/projects/esp-iot-solution/en
1919

2020
## 快速参考
2121

@@ -35,7 +35,7 @@ ESP 系列 SoC 采用 40nm 工艺制成，具有最佳的功耗性能、射频
3535

3636
| ESP-IoT-Solution | 依赖的 ESP-IDF | 主要变更 | 文档 | 支持状态 |
3737
| :--------------: | :------------: | :----------------------------------: |:------------------------------: | ---------------------- |
38-
| master | >= v4.4 | 支持组件管理器，增加新的芯片支持 | [Docs online](https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN) | 新功能开发分支 |
38+
| master | >= v4.4 | 支持组件管理器，增加新的芯片支持 | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/zh_CN) | 新功能开发分支 |
3939
| release/v1.1 | v4.0.1 | IDF 版本更新，删除已经移动到其它仓库的代码 | [v1.1 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.1#esp32-iot-solution-overview) | 备份，停止维护 |
4040
| release/v1.0 | v3.2.2 | 历史版本 | [v1.0 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.0#esp32-iot-solution-overview) | 备份，停止维护 |
4141

@@ -77,7 +77,7 @@ ESP-IoT-Solution 中注册的组件如下:
7777
7878
#### 从 ESP-IoT-Solution 仓库获取组件
7979

80-
如果您想为 `ESP-IoT-Solution` 中的组件或示例[贡献代码](https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/contribute/index.html)，或者想基于 `ESP-IoT-Solution` 中的示例开发项目，您可以通过以下步骤下载 ESP-IoT-Solution 代码仓库:
80+
如果您想为 `ESP-IoT-Solution` 中的组件或示例[贡献代码](https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/contribute/index.html)，或者想基于 `ESP-IoT-Solution` 中的示例开发项目，您可以通过以下步骤下载 ESP-IoT-Solution 代码仓库:
8181

8282
* 如果选择 `master` 版本，可使用以下指令获取代码：
8383

@@ -106,9 +106,9 @@ ESP-IoT-Solution 中注册的组件如下:
106106
107107
### 其它参考资源
108108
109-
- 最新版的文档：https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN ，该文档是由本仓库 [docs](./docs) 目录 构建得到；
109+
- 最新版的文档：https://docs.espressif.com/projects/esp-iot-solution/zh_CN ，该文档是由本仓库 [docs](./docs) 目录 构建得到；
110110
- ESP-IDF 编程指南 https://docs.espressif.com/projects/esp-idf/zh_CN ，请参考 ESP-IoT-Solution 依赖的版本；
111111
- 可以在 [ESP Component Registry](https://components.espressif.com/)中找到 `ESP-IoT-Solution` 中的组件和其他已注册的组件;
112-
- 可以前往 [esp32.com](www.esp32.com) 论坛 提问，挖掘社区资源；
112+
- 可以前往 [esp32.com](https://www.esp32.com/) 论坛 提问，挖掘社区资源；
113113
- 如果你在使用中发现了错误或者需要新的功能，请先查看 [GitHub Issues](https://github.com/espressif/esp-iot-solution/issues)，确保该问题不会被重复提交；
114114
- 如果你有兴趣为 ESP-IoT-Solution 作贡献，请先阅读[贡献指南](./CONTRIBUTING.rst)。

‎components/audio/pwm_audio/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Component: pwm_audio
44

5-
[documentation](https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/audio/pwm_audio.html)
5+
[documentation](https://docs.espressif.com/projects/esp-iot-solution/en/latest/audio/pwm_audio.html)
66

77
The PWM audio function uses the internal LEDC peripheral in ESP32 to generate PWM audio, which does not need an external audio Codec chip.
88

‎components/audio/pwm_audio/idf_component.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "1.1.1"
22
description: PWM audio output driver for ESP32 series Socs
33
url: https://github.com/espressif/esp-iot-solution/tree/master/components/audio/pwm_audio
44
repository: https://github.com/espressif/esp-iot-solution.git
5-
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/audio/pwm_audio.html
5+
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/audio/pwm_audio.html
66
issues: https://github.com/espressif/esp-iot-solution/issues
77
dependencies:
88
idf: ">=4.3"

‎components/bluetooth/ble_conn_mgr/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## v0.1.0
22

3-
This is the first release version for BLE connection management component in Espressif Component Registry, more detailed descriptions about the project, please refer to [User_Guide](https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/bluetooth/ble_conn_mgr.html).
3+
This is the first release version for BLE connection management component in Espressif Component Registry, more detailed descriptions about the project, please refer to [User_Guide](https://docs.espressif.com/projects/esp-iot-solution/en/latest/bluetooth/ble_conn_mgr.html).
44

55
Features:
66
- Roles: Support peripheral and central, client and server

‎components/bluetooth/ble_conn_mgr/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![Component Registry](https://components.espressif.com/components/espressif/ble_conn_mgr/badge.svg)](https://components.espressif.com/components/espressif/ble_conn_mgr)
44

5-
- [User Guide](https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/bluetooth/ble_conn_mgr.html)
5+
- [User Guide](https://docs.espressif.com/projects/esp-iot-solution/en/latest/bluetooth/ble_conn_mgr.html)
66

77
The ``ble_conn_mgr`` is a BLE connection management component that provides a simplified API interface for accessing commonly used BLE functionalities. It supports various scenarios such as peripheral and central.
88

‎components/button/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Component Registry](https://components.espressif.com/components/espressif/button/badge.svg)](https://components.espressif.com/components/espressif/button)
22

33
# Component: Button
4-
[Online documentation](https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/input_device/button.html)
4+
[Online documentation](https://docs.espressif.com/projects/esp-iot-solution/en/latest/input_device/button.html)
55

66
After creating a new button object by calling function `button_create()`, the button object can create press events, every press event can have its own callback.
77

‎components/button/idf_component.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "2.5.2"
22
description: GPIO and ADC button driver
33
url: https://github.com/espressif/esp-iot-solution/tree/master/components/button
44
repository: https://github.com/espressif/esp-iot-solution.git
5-
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/input_device/button.html
5+
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/input_device/button.html
66
issues: https://github.com/espressif/esp-iot-solution/issues
77
dependencies:
88
idf: ">=4.0"

‎components/knob/idf_component.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
version: "0.1.3"
22
description: Knob driver implemented through software pcnt
33
url: https://github.com/espressif/esp-iot-solution/tree/master/components/knob
4-
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/input_device/knob.html
4+
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/input_device/knob.html
55
issues: https://github.com/espressif/esp-iot-solution/issues
66
repository: https://github.com/espressif/esp-iot-solution.git
77
dependencies:

‎components/led/led_indicator/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ As one of the simplest output peripherals, LED indicators can indicate the curre
1010

1111
### LED Indicator User Guide
1212

13-
Please refer: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/display/led_indicator.html
13+
Please refer: https://docs.espressif.com/projects/esp-iot-solution/en/latest/display/led_indicator.html

‎components/openai/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The `openai` component is a porting version of [OpenAI-ESP32](https://github.com
66

77
### Open AI User Guide
88

9-
Please refer: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/ai/openai.html
9+
Please refer: https://docs.espressif.com/projects/esp-iot-solution/en/latest/ai/openai.html
1010

1111
### Add component to your project
1212

‎components/openai/idf_component.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ version: "0.1.1"
22
description: OpenAI library compatible with ESP-IDF
33
url: https://github.com/espressif/esp-iot-solution
44
repository: https://github.com/espressif/esp-iot-solution.git
5-
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/ai/openai.html
5+
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/ai/openai.html
66
issues: https://github.com/espressif/esp-iot-solution/issues
77
dependencies:
88
## Required IDF version

‎components/usb/usb_stream/CHANGELOG.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ Add additional delay to avoid malloc error if continuous suspend and resume
238238

239239
### Enhancements:
240240

241-
* add development documentation https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/usb/usb_stream.html
241+
* add development documentation https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html
242242

243243
## v0.3.0 - 2022-12-05
244244

‎components/usb/usb_stream/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Features:
1313

1414
### USB Stream User Guide
1515

16-
Please refer: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/usb/usb_stream.html
16+
Please refer: https://docs.espressif.com/projects/esp-iot-solution/en/latest/usb/usb_stream.html
1717

1818
### Add component to your project
1919

‎components/usb/usb_stream/README_CN.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
### USB Stream 用户指南
1515

16-
请参考：https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/usb/usb_stream.html
16+
请参考：https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html
1717

1818
### 添加组件到工程
1919

‎components/usb/usb_stream/idf_component.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ targets:
55
description: USB Host streaming driver, support UVC(video) + UAC(audio)
66
url: https://github.com/espressif/esp-iot-solution
77
repository: https://github.com/espressif/esp-iot-solution.git
8-
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/usb/usb_stream.html
8+
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/usb/usb_stream.html
99
issues: https://github.com/espressif/esp-iot-solution/issues
1010
dependencies:
1111
idf: ">=4.4.1"

‎docs/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Documentation Source Folder
22

3-
This folder contains source files of **ESP-IDF documentation** available in [English](https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/index.html) and [中文](https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/index.html).
3+
This folder contains source files of **ESP-IDF documentation** available in [English](https://docs.espressif.com/projects/esp-iot-solution/en/latest/index.html) and [中文](https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/index.html).
44

55
The sources do not render well in GitHub and some information is not visible at all.
66

77
Use actual documentation generated within about 20 minutes on each commit:
88

99
# Hosted Documentation
1010

11-
* English: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/index.html
12-
* 中文: https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/index.html
11+
* English: https://docs.espressif.com/projects/esp-iot-solution/en/latest/index.html
12+
* 中文: https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/index.html
1313

1414
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
1515

‎docs/en/basic/boards.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Supported Development Boards
127127
.. _esp32s3-devkitc-v1: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html
128128

129129
.. |esp32s3_usb_otg_ev| image:: ../../_static/pic_product_esp32_s3_otg.png
130-
.. _esp32s3_usb_otg_ev: https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32s3/esp32-s3-usb-otg/index.html
130+
.. _esp32s3_usb_otg_ev: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-usb-otg/index.html
131131

132132
Add a New Development Board
133133
--------------------------------------

‎docs/en/usb/usb_host_solutions.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ ESP USB Camera 视频方案
2727

2828
* 芯片： ESP32-S2，ESP32-S3
2929
* 外设：USB-OTG
30-
* USB 摄像头：支持 MJPEG 格式，批量传输模式下 800*480@15fps，同步传输模式下 480*320@15fps，摄像头限制详见 `usb_stream API 说明 <https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_
30+
* USB 摄像头：支持 MJPEG 格式，批量传输模式下 800*480@15fps，同步传输模式下 480*320@15fps，摄像头限制详见 `usb_stream API 说明 <https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_
3131

3232
链接:
3333
~~~~~
3434

3535
* `usb_stream 组件 <https://components.espressif.com/components/espressif/usb_stream>`_
36-
* `usb_stream API 说明 <https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_
36+
* `usb_stream API 说明 <https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_
3737
* `USB Camera Demo 视频 <https://www.bilibili.com/video/BV18841137qT>`_
3838
* 示例代码: USB 摄像头 + WiFi 图传 :example:`usb/host/usb_camera_mic_spk`
3939
* 示例代码: USB 摄像头 + LCD 本地刷屏 :example:`usb/host/usb_camera_lcd_display`
@@ -69,7 +69,7 @@ ESP USB Audio 音频方案
6969
~~~~~
7070

7171
* `usb_stream 组件 <https://components.espressif.com/components/espressif/usb_stream>`_
72-
* `usb_stream API 说明 <https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_
72+
* `usb_stream API 说明 <https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_stream.html>`_
7373
* `USB Audio Demo 视频 <https://www.bilibili.com/video/BV1LP411975W>`_
7474
* 示例代码: MP3 音乐播放器 + USB 耳机 :example:`usb/host/usb_audio_player`
7575

‎docs/zh_CN/basic/boards.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ Boards 组件的结构如下：
127127
.. _esp32s3-devkitc-v1: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html
128128

129129
.. |esp32s3_usb_otg_ev| image:: ../../_static/pic_product_esp32_s3_otg.png
130-
.. _esp32s3_usb_otg_ev: https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp32s3/esp32-s3-usb-otg/index.html
130+
.. _esp32s3_usb_otg_ev: https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32s3/esp32-s3-usb-otg/index.html
131131

132132
添加新的开发板
133133
----------------

0 commit comments

Comments
 (0)