Chapter 6. Contributions Guide
*
* [ESP32-S2 Technical Reference Manual](https://www.espressif.com/sites/
,→default/files/documentation/esp32-s2_technical_reference_manual_en.pdf)
*
Note: Code snippets, notes, links, etc. will not make it to the documentation, if not enclosed in a comment block
associated with one of documented objects.
6. Prepare one or more complete code examples together with description. Place description to a separate file
README.md in specific folder of examples directory.
Standardize Document Format
When it comes to text, please follow guidelines below to provide well formatted Markdown (.md) or reST (.rst)
documents.
1. Please ensure that one paragraph is written in one line. Don’t break lines like below. Breaking lines to enhance
readability is only suitable for writing codes. To make the text easier to read, it is recommended to place an
empty line to separate the paragraph.
Fig. 1: One line for one paragraph (click to enlarge)
Fig. 2: No line breaks within the same paragraph (click to enlarge)
2. Please make the line number of CN and EN documents consistent like below. The benefit of this approach
is that it can save time for both writers and translators. When non-bilingual writers need to update text, they
only need to update the same line in the corresponding CN or EN document. For translators, if documents
are updated in English, then translators can quickly locate where to update in the corresponding CN document
later. Besides, by comparing the total number of lines in EN and CN documents, you can quickly find out
whether the CN version lags behind the EN version.
Building Documentation
The documentation is built with the esp-docs Python package, which is a wrapper around Sphinx
To install it simply do:
Espressif Systems 1580
Submit Document Feedback
Release v4.4
To Next Page
Loading...
Need help?
General