Commit Graph

128 Commits

Author SHA1 Message Date
Wang Fang
a27dfe3874 docs: add an example list for esp-wrover-kit 2021-11-30 18:49:09 +08:00
Lv Xin Yue
2059280445 Doc/add esp32s3 kevkitm 1 user guide cn and en 2021-11-17 11:13:34 +00:00
Krzysztof Budzynski
612c5172f0 Merge branch 'doc/update_link_to_module_datasheet' into 'master'
docs:update the link to esp32-s3-wroom-1 datasheet

See merge request espressif/esp-idf!15741
2021-11-15 05:58:58 +00:00
Krzysztof
cc8413a330 docs: Update 'Hardware Reference' section for ESP32-S3 2021-11-02 06:56:12 +01:00
Lv Xin Yue
48f7ae266d docs:update the link to esp32-s3-wroom-1 datasheet 2021-10-29 20:05:12 +08:00
Wang Fang
ba09586a24 docs: replace the module on esp32-devkitc from esp32-wrover to esp32-wroom 2021-10-28 17:29:17 +08:00
Wang Ning
c0eaa1d99d docs/fixed_typos_in_esp32-s2-saola-1_user_guide 2021-10-18 16:54:44 +08:00
kirill.chalov
9a70313362 Added info on JTAG compatibility 2021-10-15 14:31:22 +08:00
Wang Ning
5b339fefdc docs/update_esp32-s2_devkit_user_guides 2021-09-22 14:59:06 +08:00
Wang Ning
769a9fa28f docs/update_two_esp32-c3_devkit_user_guides 2021-09-18 18:46:42 +08:00
Wang Fang
781d760873 docs: udpate devkitc and wrover-kit boards 2021-09-13 18:58:45 +08:00
Wang Ning
baf8e4694c docs/update_module_flash_size_in_ESP32-S2-DevKitC-1_user_guide 2021-08-19 17:01:58 +08:00
Lv Xin Yue
8494ef1401 Merge branch 'doc/add_esp32-s3-devkitc-1_user_guide_en' into 'master'
docs:fix a typo

See merge request espressif/esp-idf!14574
2021-08-02 06:01:58 +00:00
Wang Ning
baebf74342 docs/add_esp32-s2-devkitc-1_user_guide 2021-07-30 14:00:45 +08:00
Wang Fang
03669abead Add a note to ESP32-DevKtiM-1 User Guide, to enable single core mode
Add new module variants for ESP32-DevKitM-1 and ESP32-PICO-DevKitM-02 boards
Replace Ordering Information globally
2021-07-29 18:44:30 +08:00
Lv Xin Yue
29215ae773 docs:fix a typo 2021-07-29 16:46:15 +08:00
Lv Xin Yue
faee145a61 docs:add esp32-s3-devkitc-1 user guide 2021-07-02 15:21:07 +08:00
Krzysztof Budzynski
c07f21a467 Merge branch 'doc/remove_modules_and_boards_section_from_hw_reference' into 'master'
remove modules and boards section

Closes DOC-45 and DOC-355

See merge request espressif/esp-idf!12846
2021-05-31 11:12:51 +00:00
Hao Ning
fc0eba4101 remove modules and boards section
doc: add redirections

docs: rebase master and add redirect links

docs: delete invalid links labeled in modules-and-boards

docs:installed pre-commit config

docs:retry

docs: separate links of modules and boards

docs: removed original files and added one more redirection

docs:deleted invalid links in jtag-debugging

docs:replaced old links in jtag-debugging

docs:fixd pipeline failures
2021-05-31 16:19:15 +08:00
pedro.minatel
03cb5f8af8 Merge conflict fixed
Fixed the scale image on click to enlarge
2021-05-28 15:16:02 +01:00
Wang Ning
86a7d4c483 docs/update_strapping_pins_in_c3_devkit_user_guides 2021-05-28 03:56:22 +00:00
daiziyan
611ecc619b docs:translate chip series comparison table and update adc_types.h 2021-05-19 16:25:27 +08:00
Krzysztof
34a16c9d93 docs: Add a link to ESP32-C3 page for developers on espressif.com 2021-04-28 10:42:09 +02:00
Natasha
8fed580df6 update kaluga user guides for v1.3 2021-03-22 22:53:43 +08:00
Wang Ning
424fe73a23 Add ESP32-C3-DevKitC-02 User Guide 2021-03-17 06:40:33 +00:00
Gustavo Henrique Nihei
68b66aeee9 docs: Fix typo in ESP32-WROVER-KIT documentation 2021-03-08 14:41:20 -03:00
Wang Fang
776684fa84 docs: provide the link to pcb layout for ethernet board v1.2 and fix a typo in freetos/task 2021-02-26 10:35:21 +08:00
Wang Ning
aa2b3e1b01 Add ESP32-C3-DevKitM-1 User Guide and updated ESP32C3_DOCS 2021-02-05 12:08:21 +08:00
Krzysztof Budzynski
cee0f466f0 Merge branch 'doc/extend_and_update_chip_series_comparison' into 'master'
Update chip series comparison by adding ESP32-C3 and fixing typos

Closes DOC-776

See merge request espressif/esp-idf!11964
2021-02-03 14:46:41 +08:00
Lv Xin Yue
48f806a54b Update chip series comparison by adding ESP32-C3 and fixing typos 2021-02-03 14:46:36 +08:00
Marius Vikhammer
548fd02d10 docs: initial update of programming guide for C3
Updates "front page" content, get-started, and api-guides with C3 content

Enable building and publishing of C3 docs in CI
2021-02-01 15:40:02 +08:00
Dai Zi Yan
703aef654b provide user guide for ESP32-DevKitM-1 2021-01-05 12:32:08 +08:00
Krzysztof
37dc6044c3 docs: Add link to layout of ESP-WROVER-KIT board in DXF format 2020-12-17 19:26:05 +08:00
Wang Fang
8dbd5a48a8 provide user guide for the development board ESP32-PICO-DevKitM-2 2020-12-14 18:26:44 +08:00
Wang Fang
bdeb3a2fb6 upload user guide for development board: ESP32-PICO-KIT-1 2020-12-09 08:27:25 +00:00
Krzysztof Budzynski
90c53b1a62 docs: Provide comparison of key features of ESP32 and ESP32-S2 chips 2020-11-16 19:08:24 +08:00
Angus Gratton
66fb5a29bb Whitespace: Automated whitespace fixes (large commit)
Apply the pre-commit hook whitespace fixes to all files in the repo.

(Line endings, blank lines at end of file, trailing whitespace)
2020-11-11 07:36:35 +00:00
Wang Ning
f87cbdee28 Add ESP32-S2-DevKitM-1 User Guide
Update 1 based on comments

Fix typo

Add annotation to UFL connector

Add UFL connector to description table
2020-11-06 00:50:33 +00:00
Wang Fang
79b63189b4 docs: update the module list available for ESP32-DevKitC V4 development board 2020-08-27 04:05:18 +00:00
kirill.chalov
1a81163802 Update description of power regulators for CAM v1.0 and v1.1 2020-08-17 11:32:14 +08:00
kirill.chalov
dee1ff0218 Add user guide for Kaluga Kit v1.3 2020-08-12 17:56:59 +08:00
Wang Fang
5773767b81 Provide getting started guide for ESP32-Ethernet-Kit-V1.2 based on V1.1 2020-07-28 13:49:33 +08:00
Krzysztof Budzynski
81bfba06e1 Merge branch 'docs/saola_guide_update' into 'master'
Update ESP32-S2-Saola-1 User Guide according to DGAP-60

Closes DGAP-60

See merge request espressif/esp-idf!9632
2020-07-16 14:02:08 +08:00
Wang Ning
20190c1811 Update according to DGAP-60 2020-07-15 16:04:49 +08:00
Wang Ning
27f24a5d06 Add dimensions 2020-06-19 13:04:07 +08:00
Marius Vikhammer
67ea59d605 docs: fix check_docs not working for multiple builders
When building docs with multiple builders the warning logs are now checked after
each run. Solves the issue where the logs would be overwritten by next builder before checking.

Closes IDF-1659
2020-05-29 20:10:18 +08:00
Krzysztof Budzynski
1b49a52edd docs: OV3660 camera module is now supported with ESP32-S2-Kaluga-1 Kit. Add link back to ESP-ADF documentation in ESP-LyraT-8311A user guide. 2020-05-21 22:05:45 +08:00
Kirill Chalov
2e5f983b5a Add user guides for ESP32-S2-Kaluga-1-Kit 2020-05-13 07:12:42 +00:00
Wang Ning
158945aebf Add translation for modules-and-boards 2020-04-30 18:50:36 +08:00
Wang Ning
efba523b54 Add links to translation in Saola board user guide 2020-04-15 22:23:26 +08:00
Wang Ning
a0c37ae1bd Add ESP32-S2-Saola-1 User Guide 2020-03-26 18:40:05 +08:00
Angus Gratton
52d888a68b docs: Fix broken URLs & permanent redirects 2020-03-23 18:11:23 +11:00
Wang Ning
b85358e593 Updated index
components/esp_wifi/lib_esp32/
2020-03-11 06:43:31 +08:00
Angus Gratton
99cdddeb63 docs: Fix broken or incorrect link roles to IDF files & directories 2020-02-18 10:34:11 +11:00
Marius Vikhammer
268816649c Replace all TRM urls will generic template variable and remove duplicate sections
All references to TRM had the section duplicated for both targets using .. only:: , replaced these with a generic template url
2020-02-07 16:37:45 +11:00
Marius Vikhammer
1a90470f02 doc: Split HW-Reference into seperate files/folders for different chips 2020-02-07 16:37:44 +11:00
Marius Vikhammer
d56ea52ea1 doc: EN doc update and fixed warnings 2020-02-07 16:37:43 +11:00
Marius Vikhammer
9352899d69 doc: Update English pages with generic target name 2020-02-07 16:37:43 +11:00
Romain
35bbd996af JP8 -> JP2
Signed-off-by: Kirill Chalov <kirill.chalov@espressif.com>

Merges https://github.com/espressif/esp-idf/pull/4147
2019-12-19 12:43:41 +08:00
tianyangmin
be3e52b49c doc: Finalize Ethernet get-started guide. Add Chinese translation. 2019-12-03 02:22:06 +00:00
Krzysztof Budzynski
0abb3b99c1 Update missing description of board A and B connectors. Add a note about incorrect GPIO pin labels on the silkscreen besides the function switch. 2019-11-04 10:44:00 +08:00
Kirill Chalov
bdaf201bd0 Make "H/W Reference" toctree symmetrical
Update the toctree of "H/W Reference" to make its contents symmetrical for easier and more intuitive navigation.
2019-10-22 21:27:10 +08:00
Wang Fang
8d8ea6f698 Add Chinese translation for modules-and-boards.rst in hw-reference folder.
Note: Also modify the table in en version
2019-08-05 21:25:15 +08:00
Angus Gratton
05ac8cfb6d docs: Update description for Eclipse+Cmake support not ready yet 2019-07-09 14:32:26 +10:00
Angus Gratton
62ed221daf docs: Functional renaming commit for CMake-as-default
Rename all the files which will be edited substantially in the next commit, without changing their
contents

Docs will not build for this ocmmit.

This is done so that git doesn't decide we renamed xxx-cmake -> xxx-legacy in the next commit, which
is what it will infer otherwise (and makes rebasing more of a pain than it should be)
2019-07-08 17:31:27 +10:00
Wang Fang
b24341a664 Merge make-related documents:
1. Moved get-started files, 7 documents in total, from get-started-cmake folder to hw-reference folder;
2. Deleted get-started files, 7 documents in total, in get-started folder;
3. Updated links in get-started-cmake/index.rst and in get-started/index.rst;
4. Modified descriptions for build system in these files.
2019-07-04 13:16:18 +08:00
Kirill Chalov
752c7c32d4 Review the file hw-reference/modules-and-boards.rst 2019-06-24 08:22:43 +08:00
liying
e47047075f add translation for ESP32-Ethernet-Kit Getting Started Guide 2019-06-06 15:55:00 +08:00
Krzysztof
4e95b1ad21 Provide getting started guide for 'ESP32-Ethernet-Kit' board 2019-06-06 15:45:45 +08:00
krzychb
f675334ebb Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 19:01:34 +01:00
Krzysztof Budzynski
340e7f3b2f Provided translation of 'Hardware Reference' into Chinese 2018-12-03 07:02:33 +08:00
Krzysztof Budzynski
46c2112400 Added CN version of 'Getting Started' guides for 'ESP32-DevKitC' and 'ESP-WROVER-KIT' 2018-10-22 09:10:58 +08:00
krzychb
62389b6be6 Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference' 2018-09-05 22:10:42 +02:00
Krzysztof Budzynski
df5d3ea692 Provided a table with development boards by Espressif together with USB-to-serial driver names 2018-08-16 05:24:40 +08:00
krzychb
ca15dbd05e Added description of ESP32-PICO-KIT V4.1 board 2018-07-18 20:02:43 +02:00
krzychb
b101e118f2 Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets, reflected upcoming ESP32-SOLO-1 as one of options for ESP32-DevKitC, provided updated schematics and notes on C15. 2018-06-26 18:08:47 +02:00
Mahavir Jain
8ad8a44709 docs: fix (in remaining places) link for FTDI VCP drivers
Signed-off-by: Mahavir Jain <mahavir@espressif.com>
2018-05-22 08:21:37 +00:00
krzychb
097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00