Skip to content

Commit

Permalink
docs: change old docs link
Browse files Browse the repository at this point in the history
  • Loading branch information
lijunru-hub committed Jul 24, 2023
1 parent 7f6be2f commit a7668bb
Show file tree
Hide file tree
Showing 36 changed files with 59 additions and 55 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![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)
[![Documentation Status](https://dl.espressif.com/AE/docs/docs_latest.svg)](https://docs.espressif.com/projects/esp-iot-solution/en)

## Espressif IoT Solution Overview

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

## Documentation Center

- 中文:https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN
- English:https://docs.espressif.com/projects/espressif-esp-iot-solution/en
- 中文:https://docs.espressif.com/projects/esp-iot-solution/zh_CN
- English:https://docs.espressif.com/projects/esp-iot-solution/en

## Quick Reference

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

| ESP-IoT-Solution | Dependent ESP-IDF | Major Change | User Guide | Support State |
| :--------------: | :---------------: | :-------------------------------------------------: | :----------------------------------------------------------------------------------------------------------: | --------------------------- |
| 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 |
| 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 |
| 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 |
| 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 |

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

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:
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:

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

Expand Down Expand Up @@ -107,9 +107,9 @@ There is no difference between building and flashing the examples in ESP-IoT-Sol
### Resources
- 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.
- 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.
- ESP-IDF Programming Guide: https://docs.espressif.com/projects/esp-idf/zh_CN . Please refer to the version ESP-IoT-Solution depends on.
- The [IDF Component Registry](https://components.espressif.com/) is where you can find the components in ESP-IoT-Solution and other registered components.
- The [esp32.com forum](https://esp32.com/) is a place to ask questions and find community resources.
- The [esp32.com forum](https://www.esp32.com/) is a place to ask questions and find community resources.
- [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.
- If you're interested in contributing to ESP-IDF, please check the [Contributions Guide](./CONTRIBUTING.rst).
14 changes: 7 additions & 7 deletions README_CN.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[![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)
[![Documentation Status](https://dl.espressif.com/AE/docs/docs_latest.svg)](https://docs.espressif.com/projects/esp-iot-solution/zh_CN)

## Espressif IoT Solution 概述

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

## 文档中心

- 中文:https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN
- English: https://docs.espressif.com/projects/espressif-esp-iot-solution/en
- 中文:https://docs.espressif.com/projects/esp-iot-solution/zh_CN
- English: https://docs.espressif.com/projects/esp-iot-solution/en

## 快速参考

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

| ESP-IoT-Solution | 依赖的 ESP-IDF | 主要变更 | 文档 | 支持状态 |
| :--------------: | :------------: | :----------------------------------: |:------------------------------: | ---------------------- |
| master | >= v4.4 | 支持组件管理器,增加新的芯片支持 | [Docs online](https://docs.espressif.com/projects/espressif-esp-iot-solution/zh_CN) | 新功能开发分支 |
| master | >= v4.4 | 支持组件管理器,增加新的芯片支持 | [Docs online](https://docs.espressif.com/projects/esp-iot-solution/zh_CN) | 新功能开发分支 |
| 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) | 备份,停止维护 |
| release/v1.0 | v3.2.2 | 历史版本 | [v1.0 Overview](https://github.com/espressif/esp-iot-solution/tree/release/v1.0#esp32-iot-solution-overview) | 备份,停止维护 |

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

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

* 如果选择 `master` 版本,可使用以下指令获取代码:

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

# Component: pwm_audio

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

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

Expand Down
2 changes: 1 addition & 1 deletion components/audio/pwm_audio/idf_component.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: "1.1.1"
description: PWM audio output driver for ESP32 series Socs
url: https://github.com/espressif/esp-iot-solution/tree/master/components/audio/pwm_audio
repository: https://github.com/espressif/esp-iot-solution.git
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/audio/pwm_audio.html
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/audio/pwm_audio.html
issues: https://github.com/espressif/esp-iot-solution/issues
dependencies:
idf: ">=4.3"
Expand Down
2 changes: 1 addition & 1 deletion components/bluetooth/ble_conn_mgr/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## v0.1.0

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).
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).

Features:
- Roles: Support peripheral and central, client and server
Expand Down
2 changes: 1 addition & 1 deletion components/bluetooth/ble_conn_mgr/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

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

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

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.

Expand Down
2 changes: 1 addition & 1 deletion components/button/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[![Component Registry](https://components.espressif.com/components/espressif/button/badge.svg)](https://components.espressif.com/components/espressif/button)

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

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.

Expand Down
2 changes: 1 addition & 1 deletion components/button/idf_component.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: "2.5.2"
description: GPIO and ADC button driver
url: https://github.com/espressif/esp-iot-solution/tree/master/components/button
repository: https://github.com/espressif/esp-iot-solution.git
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/input_device/button.html
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/input_device/button.html
issues: https://github.com/espressif/esp-iot-solution/issues
dependencies:
idf: ">=4.0"
Expand Down
2 changes: 1 addition & 1 deletion components/knob/idf_component.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: "0.1.3"
description: Knob driver implemented through software pcnt
url: https://github.com/espressif/esp-iot-solution/tree/master/components/knob
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/input_device/knob.html
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/input_device/knob.html
issues: https://github.com/espressif/esp-iot-solution/issues
repository: https://github.com/espressif/esp-iot-solution.git
dependencies:
Expand Down
2 changes: 1 addition & 1 deletion components/led/led_indicator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ As one of the simplest output peripherals, LED indicators can indicate the curre

### LED Indicator User Guide

Please refer: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/display/led_indicator.html
Please refer: https://docs.espressif.com/projects/esp-iot-solution/en/latest/display/led_indicator.html
2 changes: 1 addition & 1 deletion components/openai/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The `openai` component is a porting version of [OpenAI-ESP32](https://github.com

### Open AI User Guide

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

### Add component to your project

Expand Down
2 changes: 1 addition & 1 deletion components/openai/idf_component.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: "0.1.1"
description: OpenAI library compatible with ESP-IDF
url: https://github.com/espressif/esp-iot-solution
repository: https://github.com/espressif/esp-iot-solution.git
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/ai/openai.html
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/ai/openai.html
issues: https://github.com/espressif/esp-iot-solution/issues
dependencies:
## Required IDF version
Expand Down
2 changes: 1 addition & 1 deletion components/usb/usb_stream/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Add additional delay to avoid malloc error if continuous suspend and resume

### Enhancements:

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

## v0.3.0 - 2022-12-05

Expand Down
2 changes: 1 addition & 1 deletion components/usb/usb_stream/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Features:

### USB Stream User Guide

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

### Add component to your project

Expand Down
2 changes: 1 addition & 1 deletion components/usb/usb_stream/README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

### USB Stream 用户指南

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

### 添加组件到工程

Expand Down
2 changes: 1 addition & 1 deletion components/usb/usb_stream/idf_component.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ targets:
description: USB Host streaming driver, support UVC(video) + UAC(audio)
url: https://github.com/espressif/esp-iot-solution
repository: https://github.com/espressif/esp-iot-solution.git
documentation: https://docs.espressif.com/projects/espressif-esp-iot-solution/en/latest/usb/usb_stream.html
documentation: https://docs.espressif.com/projects/esp-iot-solution/en/latest/usb/usb_stream.html
issues: https://github.com/espressif/esp-iot-solution/issues
dependencies:
idf: ">=4.4.1"
Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Documentation Source Folder

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).
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).

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

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

# Hosted Documentation

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

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.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/basic/boards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Supported Development Boards
.. _esp32s3-devkitc-v1: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html

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

Add a New Development Board
--------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/en/usb/usb_host_solutions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ ESP USB Camera 视频方案

* 芯片: ESP32-S2,ESP32-S3
* 外设:USB-OTG
* 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>`_
* 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>`_

链接:
~~~~~

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

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

Expand Down
2 changes: 1 addition & 1 deletion docs/zh_CN/basic/boards.rst
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Boards 组件的结构如下:
.. _esp32s3-devkitc-v1: https://docs.espressif.com/projects/esp-idf/en/latest/esp32s3/hw-reference/esp32s3/user-guide-devkitc-1.html

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

添加新的开发板
----------------
Expand Down
Loading

0 comments on commit a7668bb

Please sign in to comment.