Update docs #978
Update docs #978
Conversation
WalkthroughThe recent updates focus on enhancing the documentation by raising the minimum Python version requirement to 3.8, fixing typos, and refining installation instructions for the ESP-IDF in the Espressif IDE. Additionally, the changes improve clarity by specifying the correct menu paths for various commands within the IDE. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (8 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~17-~17: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ....png) > Note: It supports ESP-IDF CMake based projects (4.x and above). To get a qui...
[style] ~75-~75: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...
[typographical] ~121-~121: It seems that a comma is missing. (IF_COMMA)
Context: ...alled and if it is configured in system PATH it will be preloaded in the given view....
[typographical] ~121-~121: It seems that a comma is missing. (IF_NOT_COMMA)
Context: ...will be preloaded in the given view. If not you can Browse to the directory and sel...
[uncategorized] ~128-~128: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ... in the IDE it will be activated as well and you will see a similar entry in the edi...
[grammar] ~131-~131: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”. (MANY_NN)
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want but only one of ...
[uncategorized] ~131-~131: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...d as many version of ESP-IDF as you want but only one of the version can be set acti...
[grammar] ~131-~131: Did you mean “versions”? (CD_OF_THE_NN)
Context: ...ESP-IDF as you want but only one of the version can be set active and that will be used...
[grammar] ~133-~133: ‘Like’ cannot be used with the question word ‘how’ in this context. (HOW_IT_SHOULD_BE)
Context: ... workspace easily. Lets take a look at how the multiple versions will look like. You have to follow the same steps as d...
[style] ~140-~140: Unless you want to emphasize “not”, use “cannot” which is more common. (CAN_NOT_PREMIUM)
Context: ...made. > Note Please note that you can not delete an active ESP-IDF Version you ne...
[style] ~176-~176: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...down, which is calledLaunch Mode. 1. Select your application from the second drop-d...
[style] ~177-~177: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...aunch Configuration`(Auto-detected). 1. Select a target from the third drop-down, whic...
[misspelling] ~185-~185: This word is normally spelled as one. (EN_COMPOUNDS_AUTO_CONFIGURED)
Context: ...and it's auto-configured to flash the application with the defau...
[typographical] ~238-~238: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...pective fromWindow>Perspective>Reset Perspective..). 1. Provide theProject name. 1. Cl...
[typographical] ~370-~370: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...oolchainspreference page. 1. Click onAdd..` from the user-defined toolchains table...
[typographical] ~391-~391: The word “hence” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ...e CDT has a bug in saving the toolchain preferences, hence it's recommended to restart Eclipse bef...
[uncategorized] ~406-~406: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...toolchain now is an experimental feature and you may face some build issues due to t...
[typographical] ~406-~406: Consider adding a comma here. (PLEASE_COMMA)
Context: ...irty). To work around clang build errors please refer to [this](https://github.com/espr...
[style] ~446-~446: Consider a more expressive alternative. (DO_ACHIEVE)
Context: ... you can still use the hints viewer. To do it, you have to manually download the h...
[style] ~447-~447: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...heRawbutton and thenSave as.... To open the hints viewer go toWindows-...
[grammar] ~451-~451: Did you mean “copy and paste”? (COPY_PASTE)
Context: ...-79af28c50c55.png) Now you can type or copy paste some error from the build log, for exam...
[typographical] ~546-~546: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...ck in theProject Explorer. 1. SelectImport..Menu. 1. SelectExisting IDF Project...
[style] ~566-~566: ‘without warning’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITHOUT_WARNING)
Context: ...guration with the same name then selectOverwrite existing launch configurations without warning. 1. Click onFinish. <a name="gdbSt...
[uncategorized] ~605-~605: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ted. Remember that this is a panic mode and you cannot continue the execution from ...
[uncategorized] ~617-~617: A comma may be missing after the conjunctive/linking adverb ‘Currently’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...he chip and the configurations are set. Currently only the UART core dump capture and deb...
[style] ~652-~652: Consider using a different verb to strengthen your wording. (MAKE_SURE_ENSURE)
Context: ...ool](https://zadig.akeo.ie/). - Please make sure that the device is in download mode bef...
[style] ~673-~673: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...you must select the board you are using in order to successfully start the OpenOCD server. ...
[misspelling] ~681-~681: This word is normally spelled as one. (EN_COMPOUNDS_AUTO_CONFIGURED)
Context: ...plication-level trace dialog, there are auto-configured fields that you can change for the trac...
[uncategorized] ~688-~688: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...file://path/to/file``. *poll_period`: Data polling period (in ms) for availab...
[typographical] ~688-~688: Consider adding a comma. (IF_THEN_COMMA)
Context: ... available trace data. If greater than 0 then command runs in non-blocking mode. By d...
[uncategorized] ~689-~689: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... mode. By default, 1 ms. *trace_size: Maximum size of data to collect (in byt...
[uncategorized] ~690-~690: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...stop trigger is disabled). *stop_tmo: Idle timeout (in sec). Tracing is stopp...
[uncategorized] ~691-~691: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...commands from the target. *wait4halt: If 0 start tracing immediately, otherwi...
[uncategorized] ~692-~692: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s tracing. By default, 0. *skip_size: Number of bytes to skip at the start. B...
[grammar] ~736-~736: This expression is usually spelled with a hyphen. (NON_ANTI_JJ)
Context: ...th NVS architecture defined in [ESP_IDF Non Volatile Storage](https://docs.espressif.com/pro...
[grammar] ~771-~771: The verb “right-click” is spelled with a hyphen. (CLICK_HYPHEN)
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...
[style] ~779-~779: This phrase is redundant. Consider using “inside”. (OUTSIDE_OF)
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...
[style] ~804-~804: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...en tick mark. 1. Click onDetails. 1. Click onSummaryon the left. 1. Scroll dow...
Markdownlint
README.md
208-208: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
345-345: Expected: h2; Actual: h5 (MD001, heading-increment)
Heading levels should only increment by one level at a time
345-345: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
348-348: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
351-351: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
354-354: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
279-279: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
280-280: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
637-637: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
638-638: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
652-652: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
653-653: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
654-654: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
104-104: Expected: 0; Actual: 3 (MD007, ul-indent)
Unordered list indentation
105-105: Expected: 0; Actual: 3 (MD007, ul-indent)
Unordered list indentation
687-687: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
688-688: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
689-689: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
690-690: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
691-691: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
692-692: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
138-138: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
650-650: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
768-768: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs
98-98: Column: 1 (MD010, no-hard-tabs)
Hard tabs
99-99: Column: 1 (MD010, no-hard-tabs)
Hard tabs
100-100: Column: 1 (MD010, no-hard-tabs)
Hard tabs
375-375: Column: 1 (MD010, no-hard-tabs)
Hard tabs
376-376: Column: 1 (MD010, no-hard-tabs)
Hard tabs
377-377: Column: 1 (MD010, no-hard-tabs)
Hard tabs
588-588: Column: 1 (MD010, no-hard-tabs)
Hard tabs
589-589: Column: 1 (MD010, no-hard-tabs)
Hard tabs
590-590: Column: 1 (MD010, no-hard-tabs)
Hard tabs
591-591: Column: 1 (MD010, no-hard-tabs)
Hard tabs
595-595: Column: 1 (MD010, no-hard-tabs)
Hard tabs
596-596: Column: 1 (MD010, no-hard-tabs)
Hard tabs
597-597: Column: 1 (MD010, no-hard-tabs)
Hard tabs
598-598: Column: 1 (MD010, no-hard-tabs)
Hard tabs
652-652: Column: 1 (MD010, no-hard-tabs)
Hard tabs
653-653: Column: 1 (MD010, no-hard-tabs)
Hard tabs
654-654: Column: 1 (MD010, no-hard-tabs)
Hard tabs
687-687: Column: 1 (MD010, no-hard-tabs)
Hard tabs
688-688: Column: 1 (MD010, no-hard-tabs)
Hard tabs
689-689: Column: 1 (MD010, no-hard-tabs)
Hard tabs
690-690: Column: 1 (MD010, no-hard-tabs)
Hard tabs
691-691: Column: 1 (MD010, no-hard-tabs)
Hard tabs
692-692: Column: 1 (MD010, no-hard-tabs)
Hard tabs
719-719: Column: 1 (MD010, no-hard-tabs)
Hard tabs
721-721: Column: 1 (MD010, no-hard-tabs)
Hard tabs
723-723: Column: 1 (MD010, no-hard-tabs)
Hard tabs
731-731: Column: 1 (MD010, no-hard-tabs)
Hard tabs
739-739: Column: 1 (MD010, no-hard-tabs)
Hard tabs
740-740: Column: 1 (MD010, no-hard-tabs)
Hard tabs
741-741: Column: 1 (MD010, no-hard-tabs)
Hard tabs
742-742: Column: 1 (MD010, no-hard-tabs)
Hard tabs
751-751: Column: 1 (MD010, no-hard-tabs)
Hard tabs
756-756: Column: 1 (MD010, no-hard-tabs)
Hard tabs
760-760: Column: 1 (MD010, no-hard-tabs)
Hard tabs
762-762: Column: 1 (MD010, no-hard-tabs)
Hard tabs
764-764: Column: 1 (MD010, no-hard-tabs)
Hard tabs
786-786: Column: 1 (MD010, no-hard-tabs)
Hard tabs
787-787: Column: 1 (MD010, no-hard-tabs)
Hard tabs
788-788: Column: 1 (MD010, no-hard-tabs)
Hard tabs
789-789: Column: 1 (MD010, no-hard-tabs)
Hard tabs
790-790: Column: 1 (MD010, no-hard-tabs)
Hard tabs
16-16: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
229-229: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
249-249: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
846-846: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
21-21: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
68-68: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
71-71: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
74-74: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
80-80: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
112-112: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
143-143: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
157-157: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
172-172: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
183-183: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
194-194: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
217-217: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
217-217: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
235-235: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
251-251: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
265-265: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
276-276: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
298-298: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
312-312: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
328-328: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
345-345: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
348-348: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
351-351: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
354-354: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
366-366: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
382-382: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
396-396: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
409-409: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
427-427: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
441-441: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
499-499: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
511-511: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
524-524: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
542-542: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
556-556: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
570-570: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
633-633: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
668-668: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
710-710: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
734-734: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
769-769: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
809-809: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
810-810: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
824-824: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
848-848: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
743-743: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
33-33: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
63-63: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
72-72: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
75-75: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
83-83: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
104-104: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
164-164: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
219-219: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
220-220: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
279-279: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
99-99: null (MD034, no-bare-urls)
Bare URL used
104-104: null (MD034, no-bare-urls)
Bare URL used
105-105: null (MD034, no-bare-urls)
Bare URL used
513-513: null (MD034, no-bare-urls)
Bare URL used
530-530: null (MD034, no-bare-urls)
Bare URL used
289-289: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
293-293: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
25-25: null (MD039, no-space-in-links)
Spaces inside link text
26-26: null (MD039, no-space-in-links)
Spaces inside link text
27-27: null (MD039, no-space-in-links)
Spaces inside link text
28-28: null (MD039, no-space-in-links)
Spaces inside link text
29-29: null (MD039, no-space-in-links)
Spaces inside link text
30-30: null (MD039, no-space-in-links)
Spaces inside link text
31-31: null (MD039, no-space-in-links)
Spaces inside link text
32-32: null (MD039, no-space-in-links)
Spaces inside link text
39-39: null (MD039, no-space-in-links)
Spaces inside link text
40-40: null (MD039, no-space-in-links)
Spaces inside link text
41-41: null (MD039, no-space-in-links)
Spaces inside link text
42-42: null (MD039, no-space-in-links)
Spaces inside link text
43-43: null (MD039, no-space-in-links)
Spaces inside link text
44-44: null (MD039, no-space-in-links)
Spaces inside link text
45-45: null (MD039, no-space-in-links)
Spaces inside link text
46-46: null (MD039, no-space-in-links)
Spaces inside link text
47-47: null (MD039, no-space-in-links)
Spaces inside link text
48-48: null (MD039, no-space-in-links)
Spaces inside link text
49-49: null (MD039, no-space-in-links)
Spaces inside link text
50-50: null (MD039, no-space-in-links)
Spaces inside link text
51-51: null (MD039, no-space-in-links)
Spaces inside link text
52-52: null (MD039, no-space-in-links)
Spaces inside link text
53-53: null (MD039, no-space-in-links)
Spaces inside link text
54-54: null (MD039, no-space-in-links)
Spaces inside link text
55-55: null (MD039, no-space-in-links)
Spaces inside link text
56-56: null (MD039, no-space-in-links)
Spaces inside link text
57-57: null (MD039, no-space-in-links)
Spaces inside link text
58-58: null (MD039, no-space-in-links)
Spaces inside link text
59-59: null (MD039, no-space-in-links)
Spaces inside link text
60-60: null (MD039, no-space-in-links)
Spaces inside link text
61-61: null (MD039, no-space-in-links)
Spaces inside link text
62-62: null (MD039, no-space-in-links)
Spaces inside link text
63-63: null (MD039, no-space-in-links)
Spaces inside link text
588-588: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
595-595: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
738-738: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
786-786: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
12-12: null (MD045, no-alt-text)
Images should have alternate text (alt text)
13-13: null (MD045, no-alt-text)
Images should have alternate text (alt text)
14-14: null (MD045, no-alt-text)
Images should have alternate text (alt text)
109-109: null (MD045, no-alt-text)
Images should have alternate text (alt text)
117-117: null (MD045, no-alt-text)
Images should have alternate text (alt text)
120-120: null (MD045, no-alt-text)
Images should have alternate text (alt text)
129-129: null (MD045, no-alt-text)
Images should have alternate text (alt text)
134-134: null (MD045, no-alt-text)
Images should have alternate text (alt text)
154-154: null (MD045, no-alt-text)
Images should have alternate text (alt text)
169-169: null (MD045, no-alt-text)
Images should have alternate text (alt text)
178-178: null (MD045, no-alt-text)
Images should have alternate text (alt text)
180-180: null (MD045, no-alt-text)
Images should have alternate text (alt text)
185-185: null (MD045, no-alt-text)
Images should have alternate text (alt text)
206-206: null (MD045, no-alt-text)
Images should have alternate text (alt text)
225-225: null (MD045, no-alt-text)
Images should have alternate text (alt text)
247-247: null (MD045, no-alt-text)
Images should have alternate text (alt text)
262-262: null (MD045, no-alt-text)
Images should have alternate text (alt text)
269-269: null (MD045, no-alt-text)
Images should have alternate text (alt text)
273-273: null (MD045, no-alt-text)
Images should have alternate text (alt text)
291-291: null (MD045, no-alt-text)
Images should have alternate text (alt text)
295-295: null (MD045, no-alt-text)
Images should have alternate text (alt text)
309-309: null (MD045, no-alt-text)
Images should have alternate text (alt text)
318-318: null (MD045, no-alt-text)
Images should have alternate text (alt text)
323-323: null (MD045, no-alt-text)
Images should have alternate text (alt text)
357-357: null (MD045, no-alt-text)
Images should have alternate text (alt text)
379-379: null (MD045, no-alt-text)
Images should have alternate text (alt text)
393-393: null (MD045, no-alt-text)
Images should have alternate text (alt text)
422-422: null (MD045, no-alt-text)
Images should have alternate text (alt text)
424-424: null (MD045, no-alt-text)
Images should have alternate text (alt text)
436-436: null (MD045, no-alt-text)
Images should have alternate text (alt text)
470-470: null (MD045, no-alt-text)
Images should have alternate text (alt text)
478-478: null (MD045, no-alt-text)
Images should have alternate text (alt text)
492-492: null (MD045, no-alt-text)
Images should have alternate text (alt text)
508-508: null (MD045, no-alt-text)
Images should have alternate text (alt text)
521-521: null (MD045, no-alt-text)
Images should have alternate text (alt text)
539-539: null (MD045, no-alt-text)
Images should have alternate text (alt text)
553-553: null (MD045, no-alt-text)
Images should have alternate text (alt text)
577-577: null (MD045, no-alt-text)
Images should have alternate text (alt text)
580-580: null (MD045, no-alt-text)
Images should have alternate text (alt text)
601-601: null (MD045, no-alt-text)
Images should have alternate text (alt text)
607-607: null (MD045, no-alt-text)
Images should have alternate text (alt text)
624-624: null (MD045, no-alt-text)
Images should have alternate text (alt text)
671-671: null (MD045, no-alt-text)
Images should have alternate text (alt text)
675-675: null (MD045, no-alt-text)
Images should have alternate text (alt text)
679-679: null (MD045, no-alt-text)
Images should have alternate text (alt text)
696-696: null (MD045, no-alt-text)
Images should have alternate text (alt text)
707-707: null (MD045, no-alt-text)
Images should have alternate text (alt text)
821-821: null (MD045, no-alt-text)
Images should have alternate text (alt text)
58-58: null (MD051, link-fragments)
Link fragments should be valid
839-839: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
840-840: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
841-841: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
842-842: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
Additional comments not posted (1)
README.md (1)
84-84: Update Python version requirement to match new minimum of 3.8.- * **Python 3.6 and above** : Download and install Python from <a href="https://www.python.org/downloads/">here</a>. + * **Python 3.8 and above** : Download and install Python from <a href="https://www.python.org/downloads/">here</a>.Likely invalid or redundant comment.
| @@ -286,7 +284,7 @@ The Application Size Analysis editor provides a way to analyze the static memory | |||
| To launch the Application Size Analysis editor: | |||
|
|
|||
| 1. Right-click on the project. | |||
| 1. Select `ESP-IDF: Application Size Analysis` menu option to launch the editor. | |||
| 1. Select `ESP-IDF` > `Application Size Analysis` menu option to launch the editor. | |||
There was a problem hiding this comment.
Update menu options to reflect new structure.
- * [ ESP-IDF Application Size Analysis Editor](#sizeanalysiseditor)<br>
+ * [ ESP-IDF > Application Size Analysis Editor](#sizeanalysiseditor)<br>
- * [ ESP-IDF Application Level Tracing](#appLvlTracing)<br>
+ * [ ESP-IDF > Application Level Tracing](#appLvlTracing)<br>
- * [ ESP-IDF Partition Table Editor UI for ESP-IDF](#partitionTableEditor)<br>
+ * [ ESP-IDF > Partition Table Editor UI for ESP-IDF](#partitionTableEditor)<br>
- * [ ESP-IDF NVS Table Editor](#nvsTableEditor)<br>
+ * [ ESP-IDF > NVS Table Editor](#nvsTableEditor)<br>
- * [ ESP-IDF Write Binary Data to Flash](#writeFlashBinary)<br>
+ * [ ESP-IDF > Write Binary Data to Flash](#writeFlashBinary)<br>Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1. Select `ESP-IDF` > `Application Size Analysis` menu option to launch the editor. | |
| * [ ESP-IDF > Application Size Analysis Editor](#sizeanalysiseditor)<br> | |
| * [ ESP-IDF > Application Level Tracing](#appLvlTracing)<br> | |
| * [ ESP-IDF > Partition Table Editor UI for ESP-IDF](#partitionTableEditor)<br> | |
| * [ ESP-IDF > NVS Table Editor](#nvsTableEditor)<br> | |
| * [ ESP-IDF > Write Binary Data to Flash](#writeFlashBinary)<br> |
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
docs/images/2_environment_pref.pngis excluded by!**/*.png
Files selected for processing (1)
- README.md (13 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~17-~17: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ....png) > Note: It supports ESP-IDF CMake based projects (4.x and above). To get a qui...
[style] ~74-~74: ‘prior to’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_PRIOR_TO)
Context: ...IDF and related tools. Please note that prior to launching the IDE, you must ensure that...
[typographical] ~120-~120: It seems that a comma is missing. (IF_COMMA)
Context: ...alled and if it is configured in system PATH it will be preloaded in the given view....
[typographical] ~120-~120: It seems that a comma is missing. (IF_NOT_COMMA)
Context: ...will be preloaded in the given view. If not you can Browse to the directory and sel...
[uncategorized] ~124-~124: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... selecting an already installed ESP-IDF directory IDE will automatically pick up the pyth...
[uncategorized] ~127-~127: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ... in the IDE it will be activated as well and you will see a similar entry in the edi...
[grammar] ~130-~130: Possible agreement error. The noun ‘version’ seems to be countable; consider using: “many versions”. (MANY_NN)
Context: ...lled_and_activated.png) You can add as many version of ESP-IDF as you want but only one of ...
[uncategorized] ~130-~130: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...d as many version of ESP-IDF as you want but only one of the version can be set acti...
[grammar] ~130-~130: Did you mean “versions”? (CD_OF_THE_NN)
Context: ...ESP-IDF as you want but only one of the version can be set active and that will be used...
[uncategorized] ~131-~131: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...ween versions in the workspace easily. Lets take a look at how the multiple version...
[grammar] ~132-~132: ‘Like’ cannot be used with the question word ‘how’ in this context. (HOW_IT_SHOULD_BE)
Context: ... workspace easily. Lets take a look at how the multiple versions will look like. You have to follow the same steps as d...
[style] ~139-~139: Unless you want to emphasize “not”, use “cannot” which is more common. (CAN_NOT_PREMIUM)
Context: ...made. > Note Please note that you can not delete an active ESP-IDF Version you ne...
[uncategorized] ~139-~139: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...at you can not delete an active ESP-IDF Version you need to activate another version be...
[style] ~175-~175: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...down, which is calledLaunch Mode. 1. Select your application from the second drop-d...
[style] ~176-~176: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...aunch Configuration`(Auto-detected). 1. Select a target from the third drop-down, whic...
[misspelling] ~184-~184: This word is normally spelled as one. (EN_COMPOUNDS_AUTO_CONFIGURED)
Context: ...
[uncategorized] ~222-~222: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ew for the new debug configuration will open where it's necessary to check the board...
[typographical] ~237-~237: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...pective fromWindow>Perspective>Reset Perspective..). 1. Provide theProject name. 1. Cl...
[typographical] ~344-~344: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...oolchainspreference page. 1. Click onAdd..` from the user-defined toolchains table...
[typographical] ~365-~365: The word “hence” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ...e CDT has a bug in saving the toolchain preferences, hence it's recommended to restart Eclipse bef...
[uncategorized] ~377-~377: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...toolchain now is an experimental feature and you may face some build issues due to t...
[typographical] ~377-~377: Consider adding a comma here. (PLEASE_COMMA)
Context: ...irty). To work around clang build errors please refer to [this](https://github.com/espr...
[uncategorized] ~404-~404: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...rom the drop-down menu. 1. From the sub menu select the language you want. 1. IDE wi...
[style] ~417-~417: Consider a more expressive alternative. (DO_ACHIEVE)
Context: ... you can still use the hints viewer. To do it, you have to manually download the h...
[style] ~418-~418: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...heRawbutton and thenSave as.... To open the hints viewer go toWindows-...
[uncategorized] ~419-~419: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...d thenSave as.... To open the hints viewer go toWindows->Show View-> `Othe...
[grammar] ~422-~422: Did you mean “copy and paste”? (COPY_PASTE)
Context: ...-79af28c50c55.png) Now you can type or copy paste some error from the build log, for exam...
[typographical] ~517-~517: Two consecutive dots (DOUBLE_PUNCTUATION)
Context: ...ck in theProject Explorer. 1. SelectImport..Menu. 1. SelectExisting IDF Project...
[uncategorized] ~537-~537: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...an existing configuration with the same name then select `Overwrite existing launch ...
[style] ~537-~537: ‘without warning’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_WITHOUT_WARNING)
Context: ...guration with the same name then selectOverwrite existing launch configurations without warning. 1. Click onFinish. <a name="gdbSt...
[uncategorized] ~576-~576: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ted. Remember that this is a panic mode and you cannot continue the execution from ...
[uncategorized] ~582-~582: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... in the stack frame. To exit the debug session simply pressstopbutton. <a name="c...
[uncategorized] ~588-~588: A comma may be missing after the conjunctive/linking adverb ‘Currently’. (SENT_START_CONJUNCTIVE_LINKING_ADVERB_COMMA)
Context: ...he chip and the configurations are set. Currently only the UART core dump capture and deb...
[uncategorized] ~592-~592: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... the project root by double-clicking on it which will open the configuration edito...
[style] ~623-~623: Consider using a different verb to strengthen your wording. (MAKE_SURE_ENSURE)
Context: ...ool](https://zadig.akeo.ie/). - Please make sure that the device is in download mode bef...
[uncategorized] ~644-~644: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...to create a debug configuration for the project where you must select the board you are...
[style] ~644-~644: Consider a shorter alternative to avoid wordiness. (IN_ORDER_TO_PREMIUM)
Context: ...you must select the board you are using in order to successfully start the OpenOCD server. ...
[misspelling] ~652-~652: This word is normally spelled as one. (EN_COMPOUNDS_AUTO_CONFIGURED)
Context: ...plication-level trace dialog, there are auto-configured fields that you can change for the trac...
[uncategorized] ~659-~659: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...file://path/to/file``. *poll_period`: Data polling period (in ms) for availab...
[typographical] ~659-~659: Consider adding a comma. (IF_THEN_COMMA)
Context: ... available trace data. If greater than 0 then command runs in non-blocking mode. By d...
[uncategorized] ~659-~659: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...able trace data. If greater than 0 then command runs in non-blocking mode. By default, ...
[uncategorized] ~660-~660: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ... mode. By default, 1 ms. *trace_size: Maximum size of data to collect (in byt...
[uncategorized] ~660-~660: Possible missing article found. (AI_HYDRA_LEO_MISSING_A)
Context: ...ct (in bytes). Tracing is stopped after specified amount of data is received. By default ...
[uncategorized] ~660-~660: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...pecified amount of data is received. By default -1 (trace size stop trigger is disabled...
[uncategorized] ~661-~661: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...stop trigger is disabled). *stop_tmo: Idle timeout (in sec). Tracing is stopp...
[uncategorized] ~662-~662: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...commands from the target. *wait4halt: If 0 start tracing immediately, otherwi...
[uncategorized] ~663-~663: Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION)
Context: ...s tracing. By default, 0. *skip_size: Number of bytes to skip at the start. B...
[uncategorized] ~673-~673: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: .../trace/file/path/to/program/elf/file. Note theStart parse` button is disabled un...
[grammar] ~707-~707: This expression is usually spelled with a hyphen. (NON_ANTI_JJ)
Context: ...th NVS architecture defined in [ESP_IDF Non Volatile Storage](https://docs.espressif.com/pro...
[uncategorized] ~729-~729: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...binary (Chooseencryptto encrypt the binary and disable the generate key option to ...
[grammar] ~742-~742: The verb “right-click” is spelled with a hyphen. (CLICK_HYPHEN)
Context: ...ry Data to Flash` command accessible by right click on the project in the project explorer:...
[uncategorized] ~750-~750: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...089ea7"> After clicking on theFlashbutton the result of the flash command will be...
[style] ~750-~750: This phrase is redundant. Consider using “inside”. (OUTSIDE_OF)
Context: ...lt of the flash command will be printed inside of this dialog. # How to build locally 1...
[style] ~775-~775: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym. (ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Context: ...en tick mark. 1. Click onDetails. 1. Click onSummaryon the left. 1. Scroll dow...
[uncategorized] ~787-~787: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...tom build path>` with an absolute path. Customized build directory path could be within th...
Markdownlint
README.md
207-207: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
278-278: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
279-279: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
608-608: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
609-609: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
623-623: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
624-624: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
625-625: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
103-103: Expected: 0; Actual: 3 (MD007, ul-indent)
Unordered list indentation
104-104: Expected: 0; Actual: 3 (MD007, ul-indent)
Unordered list indentation
658-658: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
659-659: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
660-660: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
661-661: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
662-662: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
663-663: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
137-137: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
621-621: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
739-739: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs
97-97: Column: 1 (MD010, no-hard-tabs)
Hard tabs
98-98: Column: 1 (MD010, no-hard-tabs)
Hard tabs
99-99: Column: 1 (MD010, no-hard-tabs)
Hard tabs
349-349: Column: 1 (MD010, no-hard-tabs)
Hard tabs
350-350: Column: 1 (MD010, no-hard-tabs)
Hard tabs
351-351: Column: 1 (MD010, no-hard-tabs)
Hard tabs
559-559: Column: 1 (MD010, no-hard-tabs)
Hard tabs
560-560: Column: 1 (MD010, no-hard-tabs)
Hard tabs
561-561: Column: 1 (MD010, no-hard-tabs)
Hard tabs
562-562: Column: 1 (MD010, no-hard-tabs)
Hard tabs
566-566: Column: 1 (MD010, no-hard-tabs)
Hard tabs
567-567: Column: 1 (MD010, no-hard-tabs)
Hard tabs
568-568: Column: 1 (MD010, no-hard-tabs)
Hard tabs
569-569: Column: 1 (MD010, no-hard-tabs)
Hard tabs
623-623: Column: 1 (MD010, no-hard-tabs)
Hard tabs
624-624: Column: 1 (MD010, no-hard-tabs)
Hard tabs
625-625: Column: 1 (MD010, no-hard-tabs)
Hard tabs
658-658: Column: 1 (MD010, no-hard-tabs)
Hard tabs
659-659: Column: 1 (MD010, no-hard-tabs)
Hard tabs
660-660: Column: 1 (MD010, no-hard-tabs)
Hard tabs
661-661: Column: 1 (MD010, no-hard-tabs)
Hard tabs
662-662: Column: 1 (MD010, no-hard-tabs)
Hard tabs
663-663: Column: 1 (MD010, no-hard-tabs)
Hard tabs
690-690: Column: 1 (MD010, no-hard-tabs)
Hard tabs
692-692: Column: 1 (MD010, no-hard-tabs)
Hard tabs
694-694: Column: 1 (MD010, no-hard-tabs)
Hard tabs
702-702: Column: 1 (MD010, no-hard-tabs)
Hard tabs
710-710: Column: 1 (MD010, no-hard-tabs)
Hard tabs
711-711: Column: 1 (MD010, no-hard-tabs)
Hard tabs
712-712: Column: 1 (MD010, no-hard-tabs)
Hard tabs
713-713: Column: 1 (MD010, no-hard-tabs)
Hard tabs
722-722: Column: 1 (MD010, no-hard-tabs)
Hard tabs
727-727: Column: 1 (MD010, no-hard-tabs)
Hard tabs
731-731: Column: 1 (MD010, no-hard-tabs)
Hard tabs
733-733: Column: 1 (MD010, no-hard-tabs)
Hard tabs
735-735: Column: 1 (MD010, no-hard-tabs)
Hard tabs
757-757: Column: 1 (MD010, no-hard-tabs)
Hard tabs
758-758: Column: 1 (MD010, no-hard-tabs)
Hard tabs
759-759: Column: 1 (MD010, no-hard-tabs)
Hard tabs
760-760: Column: 1 (MD010, no-hard-tabs)
Hard tabs
761-761: Column: 1 (MD010, no-hard-tabs)
Hard tabs
16-16: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
228-228: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
248-248: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
817-817: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
21-21: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
67-67: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
70-70: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
73-73: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
79-79: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
111-111: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
142-142: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
156-156: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
171-171: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
182-182: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
193-193: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
216-216: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
216-216: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
234-234: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
250-250: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
264-264: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
275-275: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
297-297: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
311-311: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
327-327: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
340-340: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
356-356: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
370-370: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
380-380: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
398-398: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
412-412: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
470-470: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
482-482: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
495-495: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
513-513: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
527-527: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
541-541: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
604-604: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
639-639: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
681-681: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
705-705: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
740-740: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
780-780: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
781-781: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
795-795: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
819-819: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
714-714: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
33-33: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
62-62: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
71-71: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
74-74: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
82-82: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
103-103: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
163-163: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
218-218: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
219-219: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
278-278: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
98-98: null (MD034, no-bare-urls)
Bare URL used
103-103: null (MD034, no-bare-urls)
Bare URL used
104-104: null (MD034, no-bare-urls)
Bare URL used
484-484: null (MD034, no-bare-urls)
Bare URL used
501-501: null (MD034, no-bare-urls)
Bare URL used
288-288: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
292-292: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
25-25: null (MD039, no-space-in-links)
Spaces inside link text
26-26: null (MD039, no-space-in-links)
Spaces inside link text
27-27: null (MD039, no-space-in-links)
Spaces inside link text
28-28: null (MD039, no-space-in-links)
Spaces inside link text
29-29: null (MD039, no-space-in-links)
Spaces inside link text
30-30: null (MD039, no-space-in-links)
Spaces inside link text
31-31: null (MD039, no-space-in-links)
Spaces inside link text
32-32: null (MD039, no-space-in-links)
Spaces inside link text
39-39: null (MD039, no-space-in-links)
Spaces inside link text
40-40: null (MD039, no-space-in-links)
Spaces inside link text
41-41: null (MD039, no-space-in-links)
Spaces inside link text
42-42: null (MD039, no-space-in-links)
Spaces inside link text
43-43: null (MD039, no-space-in-links)
Spaces inside link text
44-44: null (MD039, no-space-in-links)
Spaces inside link text
45-45: null (MD039, no-space-in-links)
Spaces inside link text
46-46: null (MD039, no-space-in-links)
Spaces inside link text
47-47: null (MD039, no-space-in-links)
Spaces inside link text
48-48: null (MD039, no-space-in-links)
Spaces inside link text
49-49: null (MD039, no-space-in-links)
Spaces inside link text
50-50: null (MD039, no-space-in-links)
Spaces inside link text
51-51: null (MD039, no-space-in-links)
Spaces inside link text
52-52: null (MD039, no-space-in-links)
Spaces inside link text
53-53: null (MD039, no-space-in-links)
Spaces inside link text
54-54: null (MD039, no-space-in-links)
Spaces inside link text
55-55: null (MD039, no-space-in-links)
Spaces inside link text
56-56: null (MD039, no-space-in-links)
Spaces inside link text
57-57: null (MD039, no-space-in-links)
Spaces inside link text
58-58: null (MD039, no-space-in-links)
Spaces inside link text
59-59: null (MD039, no-space-in-links)
Spaces inside link text
60-60: null (MD039, no-space-in-links)
Spaces inside link text
61-61: null (MD039, no-space-in-links)
Spaces inside link text
62-62: null (MD039, no-space-in-links)
Spaces inside link text
559-559: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
566-566: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
709-709: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
757-757: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
12-12: null (MD045, no-alt-text)
Images should have alternate text (alt text)
13-13: null (MD045, no-alt-text)
Images should have alternate text (alt text)
14-14: null (MD045, no-alt-text)
Images should have alternate text (alt text)
108-108: null (MD045, no-alt-text)
Images should have alternate text (alt text)
116-116: null (MD045, no-alt-text)
Images should have alternate text (alt text)
119-119: null (MD045, no-alt-text)
Images should have alternate text (alt text)
128-128: null (MD045, no-alt-text)
Images should have alternate text (alt text)
133-133: null (MD045, no-alt-text)
Images should have alternate text (alt text)
153-153: null (MD045, no-alt-text)
Images should have alternate text (alt text)
168-168: null (MD045, no-alt-text)
Images should have alternate text (alt text)
177-177: null (MD045, no-alt-text)
Images should have alternate text (alt text)
179-179: null (MD045, no-alt-text)
Images should have alternate text (alt text)
184-184: null (MD045, no-alt-text)
Images should have alternate text (alt text)
205-205: null (MD045, no-alt-text)
Images should have alternate text (alt text)
224-224: null (MD045, no-alt-text)
Images should have alternate text (alt text)
246-246: null (MD045, no-alt-text)
Images should have alternate text (alt text)
261-261: null (MD045, no-alt-text)
Images should have alternate text (alt text)
268-268: null (MD045, no-alt-text)
Images should have alternate text (alt text)
272-272: null (MD045, no-alt-text)
Images should have alternate text (alt text)
290-290: null (MD045, no-alt-text)
Images should have alternate text (alt text)
294-294: null (MD045, no-alt-text)
Images should have alternate text (alt text)
308-308: null (MD045, no-alt-text)
Images should have alternate text (alt text)
317-317: null (MD045, no-alt-text)
Images should have alternate text (alt text)
322-322: null (MD045, no-alt-text)
Images should have alternate text (alt text)
331-331: null (MD045, no-alt-text)
Images should have alternate text (alt text)
353-353: null (MD045, no-alt-text)
Images should have alternate text (alt text)
367-367: null (MD045, no-alt-text)
Images should have alternate text (alt text)
393-393: null (MD045, no-alt-text)
Images should have alternate text (alt text)
395-395: null (MD045, no-alt-text)
Images should have alternate text (alt text)
407-407: null (MD045, no-alt-text)
Images should have alternate text (alt text)
441-441: null (MD045, no-alt-text)
Images should have alternate text (alt text)
449-449: null (MD045, no-alt-text)
Images should have alternate text (alt text)
463-463: null (MD045, no-alt-text)
Images should have alternate text (alt text)
479-479: null (MD045, no-alt-text)
Images should have alternate text (alt text)
492-492: null (MD045, no-alt-text)
Images should have alternate text (alt text)
510-510: null (MD045, no-alt-text)
Images should have alternate text (alt text)
524-524: null (MD045, no-alt-text)
Images should have alternate text (alt text)
548-548: null (MD045, no-alt-text)
Images should have alternate text (alt text)
551-551: null (MD045, no-alt-text)
Images should have alternate text (alt text)
572-572: null (MD045, no-alt-text)
Images should have alternate text (alt text)
578-578: null (MD045, no-alt-text)
Images should have alternate text (alt text)
595-595: null (MD045, no-alt-text)
Images should have alternate text (alt text)
642-642: null (MD045, no-alt-text)
Images should have alternate text (alt text)
646-646: null (MD045, no-alt-text)
Images should have alternate text (alt text)
650-650: null (MD045, no-alt-text)
Images should have alternate text (alt text)
667-667: null (MD045, no-alt-text)
Images should have alternate text (alt text)
678-678: null (MD045, no-alt-text)
Images should have alternate text (alt text)
792-792: null (MD045, no-alt-text)
Images should have alternate text (alt text)
810-810: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
811-811: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
812-812: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
813-813: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column count
Additional comments not posted (2)
README.md (2)
83-83: Update Python version requirement to match new minimum.The update from Python 3.6 to 3.8 as a minimum requirement is correctly reflected in the documentation. This change aligns with modern Python usage and ensures compatibility with newer libraries and features.
57-57: Standardize menu options format.The changes to standardize the menu options format to
ESP-IDF > Featureenhance clarity and consistency across the documentation. This format makes it easier for users to navigate and understand the available features.Also applies to: 286-286
Tools
Markdownlint
57-57: null (MD039, no-space-in-links)
Spaces inside link text
Description
Please include a summary of the change and which issue is fixed.
Fixes # (IEP-XXX)
Type of change
Please delete options that are not relevant.
How has this been tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
Test Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit