fix: move docs to docs_readme #985
Conversation
Will use docs folder for publishing to docs.espressif.com
WalkthroughThe changes primarily involve updating image paths and documentation links in several markdown files. The updates ensure that all references now point to the new 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: 47
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (154)
docs_readme/images/10_serial_terminal.pngis excluded by!**/*.pngdocs_readme/images/11_launch_configuration.pngis excluded by!**/*.pngdocs_readme/images/12_flashing.pngis excluded by!**/*.pngdocs_readme/images/13_sdkconfig_editor.pngis excluded by!**/*.pngdocs_readme/images/1_idffeature_install.pngis excluded by!**/*.pngdocs_readme/images/2_environment_pref.pngis excluded by!**/*.pngdocs_readme/images/3_new_project_default.pngis excluded by!**/*.pngdocs_readme/images/4_new_project_templates.pngis excluded by!**/*.pngdocs_readme/images/5_import_project.pngis excluded by!**/*.pngdocs_readme/images/6_core_build_toolchains.pngis excluded by!**/*.pngdocs_readme/images/7_cmake_toolchain.pngis excluded by!**/*.pngdocs_readme/images/8_launch_target.pngis excluded by!**/*.pngdocs_readme/images/9_cmake_build.pngis excluded by!**/*.pngdocs_readme/images/AppLvlTracing_1.pngis excluded by!**/*.pngdocs_readme/images/AppLvlTracing_2.pngis excluded by!**/*.pngdocs_readme/images/AppLvlTracing_3.pngis excluded by!**/*.pngdocs_readme/images/AppLvlTracing_4.pngis excluded by!**/*.pngdocs_readme/images/AppLvlTracing_5.pngis excluded by!**/*.pngdocs_readme/images/CDT_Build_Console.pngis excluded by!**/*.pngdocs_readme/images/CoreDumpDebugging/sdkconfig_editor.pngis excluded by!**/*.pngdocs_readme/images/ESP-IDF_Components/components_window.pngis excluded by!**/*.pngdocs_readme/images/ESP-IDF_Components/install_components.pngis excluded by!**/*.pngdocs_readme/images/GDBStubDebugging/code_example.pngis excluded by!**/*.pngdocs_readme/images/GDBStubDebugging/debug_panic_mode.pngis excluded by!**/*.pngdocs_readme/images/GDBStubDebugging/sdkconfig_editor.pngis excluded by!**/*.pngdocs_readme/images/GDBStubDebugging/sdkconfig_editor_panic_behavior.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/analysis_context_menu.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/breakpoint_properties_actions.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/breakpoint_properties_actions_start_attached.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/breakpoint_properties_actions_stop_attached.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/breakpoint_properties_popup.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/callers_view.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/details_tab_tracing.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/heap_tracing_action.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/overview_tab_tracing.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/overview_tab_tracing_contexts.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/show_callers_context_menu.pngis excluded by!**/*.pngdocs_readme/images/HeapTracing/sysview_heap_log_file.PNGis excluded by!**/*.pngdocs_readme/images/IDF_tools_console.pngis excluded by!**/*.pngdocs_readme/images/JtagFlash_1.pngis excluded by!**/*.pngdocs_readme/images/JtagFlash_2.pngis excluded by!**/*.pngdocs_readme/images/JtagFlash_3.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_1.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_10.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_11.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_12.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_13.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_2.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_3.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_4.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_5.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_6.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_7.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_8.pngis excluded by!**/*.pngdocs_readme/images/OpenOCDDebug_9.pngis excluded by!**/*.pngdocs_readme/images/Preference_recorder.pngis excluded by!**/*.pngdocs_readme/images/ToolsManager/ESP-IDF_Configuration_Download_or_Use_ESP-IDF.pngis excluded by!**/*.pngdocs_readme/images/ToolsManager/ESP-IDF_Manager_Editor_Screen.pngis excluded by!**/*.pngdocs_readme/images/ToolsManager/ESP-IDF_Manager_Multiple_versions.pngis excluded by!**/*.pngdocs_readme/images/ToolsManager/Tool_installed_and_activated.pngis excluded by!**/*.pngdocs_readme/images/ToolsValidation/EnvSettings.pngis excluded by!**/*.pngdocs_readme/images/ToolsValidation/PathVarEdit.pngis excluded by!**/*.pngdocs_readme/images/ToolsValidation/PathVarEdited.pngis excluded by!**/*.pngdocs_readme/images/Update_plugins.pngis excluded by!**/*.pngdocs_readme/images/buildconfiguration_clang.pngis excluded by!**/*.pngdocs_readme/images/change_language.pngis excluded by!**/*.pngdocs_readme/images/cland_starting.pngis excluded by!**/*.pngdocs_readme/images/clangd/build_settings_clang.pngis excluded by!**/*.pngdocs_readme/images/clangd/cdt_indexer_disable.pngis excluded by!**/*.pngdocs_readme/images/clangd/cdtlsp_updatesite.pngis excluded by!**/*.pngdocs_readme/images/clangd/clang_compiler_config.pngis excluded by!**/*.pngdocs_readme/images/clangd/clangd_config.pngis excluded by!**/*.pngdocs_readme/images/clangd/clangd_context_help.pngis excluded by!**/*.pngdocs_readme/images/clangd/clangd_editor.pngis excluded by!**/*.pngdocs_readme/images/clangd/new_cmake_clang_toolchain_config.pngis excluded by!**/*.pngdocs_readme/images/clangd_consolelog_config.pngis excluded by!**/*.pngdocs_readme/images/clangd_generic_editor.pngis excluded by!**/*.pngdocs_readme/images/clangd_preference.pngis excluded by!**/*.pngdocs_readme/images/clangd_proposals.pngis excluded by!**/*.pngdocs_readme/images/clangd_updatesite.pngis excluded by!**/*.pngdocs_readme/images/cmake_editor_ca.pngis excluded by!**/*.pngdocs_readme/images/cmake_editor_preferences.pngis excluded by!**/*.pngdocs_readme/images/code_analysis_disable_symbols.pngis excluded by!**/*.pngdocs_readme/images/custombuilddir.pngis excluded by!**/*.pngdocs_readme/images/espressifide_splash.bmpis excluded by!**/*.bmpdocs_readme/images/export_log.pngis excluded by!**/*.pngdocs_readme/images/icons/build.pngis excluded by!**/*.pngdocs_readme/images/icons/debug.pngis excluded by!**/*.pngdocs_readme/images/icons/delete.pngis excluded by!**/*.pngdocs_readme/images/icons/run.pngis excluded by!**/*.pngdocs_readme/images/icons/terminate.pngis excluded by!**/*.pngdocs_readme/images/idf_terminal.pngis excluded by!**/*.pngdocs_readme/images/idf_update_site_install.pngis excluded by!**/*.pngdocs_readme/images/linux-logo.pngis excluded by!**/*.pngdocs_readme/images/macos-logo.pngis excluded by!**/*.pngdocs_readme/images/market_place.pngis excluded by!**/*.pngdocs_readme/images/sizeanalysis_details.pngis excluded by!**/*.pngdocs_readme/images/sizeanalysis_overview.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_0.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_1.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_10.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_11.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_12.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_13.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_14.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_2.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_3.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_4.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_5.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_6.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_7.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_8.pngis excluded by!**/*.pngdocs_readme/images/windows-installation/ide_windows_installer_9.pngis excluded by!**/*.pngdocs_readme/images/windows-logo.pngis excluded by!**/*.pngdocs_readme/images/zh/10_serial_terminal.pngis excluded by!**/*.pngdocs_readme/images/zh/11_launch_configuration.pngis excluded by!**/*.pngdocs_readme/images/zh/1_idffeature_install.pngis excluded by!**/*.pngdocs_readme/images/zh/2_environment_pref.pngis excluded by!**/*.pngdocs_readme/images/zh/3_new_project_default.pngis excluded by!**/*.pngdocs_readme/images/zh/4_new_project_templates.pngis excluded by!**/*.pngdocs_readme/images/zh/5_import_project.pngis excluded by!**/*.pngdocs_readme/images/zh/8_launch_target.pngis excluded by!**/*.pngdocs_readme/images/zh/ESP-IDF_Components/components_window.pngis excluded by!**/*.pngdocs_readme/images/zh/ESP-IDF_Components/install_components.pngis excluded by!**/*.pngdocs_readme/images/zh/GDBStubDebugging/code_example.pngis excluded by!**/*.pngdocs_readme/images/zh/GDBStubDebugging/debug_panic_mode.pngis excluded by!**/*.pngdocs_readme/images/zh/GDBStubDebugging/sdkconfig_editor.pngis excluded by!**/*.pngdocs_readme/images/zh/GDBStubDebugging/sdkconfig_editor_panic_behavior.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/analysis_context_menu.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/breakpoint_properties_actions.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/breakpoint_properties_actions_start_attached.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/breakpoint_properties_actions_stop_attached.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/breakpoint_properties_popup.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/callers_view.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/details_tab_tracing.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/heap_tracing_action.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/overview_tab_tracing.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/overview_tab_tracing_contexts.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/show_callers_context_menu.pngis excluded by!**/*.pngdocs_readme/images/zh/HeapTracing/sysview_heap_log_file.PNGis excluded by!**/*.pngdocs_readme/images/zh/IDF_tools_console.pngis excluded by!**/*.pngdocs_readme/images/zh/ToolsManager/git_python_selection.pngis excluded by!**/*.pngdocs_readme/images/zh/ToolsManager/install_tools_manager.pngis excluded by!**/*.pngdocs_readme/images/zh/ToolsManager/manage_tools_installation.pngis excluded by!**/*.pngdocs_readme/images/zh/ToolsManager/select_or_download_new_esp_idf.pngis excluded by!**/*.pngdocs_readme/images/zh/change_language.pngis excluded by!**/*.pngdocs_readme/images/zh/cmake_editor_preferences.pngis excluded by!**/*.pngdocs_readme/images/zh/esp_idf_dir.pngis excluded by!**/*.pngdocs_readme/images/zh/espidf_download.pngis excluded by!**/*.pngdocs_readme/images/zh/export_log.pngis excluded by!**/*.pngdocs_readme/images/zh/idf_terminal.pngis excluded by!**/*.pngdocs_readme/images/zh/idf_update_site_install.pngis excluded by!**/*.pngdocs_readme/images/zh/sizeanalysis_details.pngis excluded by!**/*.pngdocs_readme/images/zh/sizeanalysis_overview.pngis excluded by!**/*.png
Files selected for processing (4)
- README.md (32 hunks)
- README_CN.md (35 hunks)
- docs_readme/Espressif-IDE.md (1 hunks)
- docs_readme/OpenOCD Debugging.md (1 hunks)
Files not reviewed due to errors (1)
- docs_readme/Espressif-IDE.md (no review received)
Additional context used
LanguageTool
docs_readme/Espressif-IDE.md
[uncategorized] ~19-~19: This expression is usually spelled with a hyphen. (BASED_HYPHEN)
Context: ...ng CMake files such as CMakeLists.txt - CMake based build support - Support for UART and JT...
[duplication] ~19-~19: Possible typo: you repeated a word (ENGLISH_WORD_REPEAT_RULE)
Context: ...h as CMakeLists.txt - CMake based build support - Support for UART and JTAG flashing - Customized...
[misspelling] ~30-~30: This word is normally spelled as one. (EN_COMPOUNDS_ECO_SYSTEM)
Context: ... other third-party plugins from Eclipse eco-system - Host operating systems supported: Win...
[uncategorized] ~41-~41: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ...t">Espressif-IDE-win32.win32.x86_64 | | macOS x86_64 | <a href ="https://dl....
[uncategorized] ~44-~44: A punctuation mark might be missing here. (AI_EN_LECTOR_MISSING_PUNCTUATION)
Context: ...est">Espressif-IDE-linux.gtk.x86_64 | ### macOS security notice (Applicable...docs_readme/OpenOCD Debugging.md
[typographical] ~3-~3: Consider adding a comma here. (PLEASE_COMMA)
Context: ...ing ## Create a new debug configuration Please follow the below steps to create a new ...
[uncategorized] ~10-~10: When ‘project-specific’ is used as a modifier, it is usually spelled with a hyphen. (SPECIFIC_HYPHEN)
Context: ...navigate through each tab and configure project specific settings. > NOTE: Most of the set...
[misspelling] ~11-~11: This word is normally spelled as one. (EN_COMPOUNDS_AUTO_CONFIGURED)
Context: ... > NOTE: Most of the settings are auto-configured by the plugin. 
Context: ...ectESP-IDF GDB OpenOCD Debuggingand double click on it or onNext >button * In the `D...
[uncategorized] ~26-~26: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ... select the project if it's not selected or you want to change it. 3. In the next l...
[grammar] ~27-~27: Make sure that the noun ‘build’ is correct. Did you mean the past participle “built”? (BE_VB_OR_NN)
Context: ..., then likely this project has not been build yet. After building the project, the el...
[typographical] ~27-~27: The word “however” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (HOWEVER_SENTENCE)
Context: ... project, the elf file will appear there, however, you can change it by pressing "Browse" ...
[uncategorized] ~29-~29: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’). (AUTO_HYPHEN)
Context: ...sing the "Debug" button, click “Disable auto build”. Points 1 - 3 are shown below. 
Context: ...n, click “Disable auto build”. Points 1 - 3 are shown below. 
Context: ...options, that you need to check if they auto configured correctly for you: 4. The "Executable ...
[style] ~39-~39: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_NEED_TO_VB)
Context: ...e tools installation went wrong, so you need to check if tools installed correctly to a...
[style] ~40-~40: Consider using a different verb to strengthen your wording. (MAKE_SURE_ENSURE)
Context: ...` manually. 5. In the next step, please make sure that the GDB port is 3333 if you want t...
[style] ~40-~40: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing. (REP_WANT_TO_VB)
Context: ... client and the Tcl port is 6666 if you want to use [Application Level Tracing](https:/...
[uncategorized] ~41-~41: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...bed above. 6. In theGDB Client Setupsection as described above, the gdb executable ...
[typographical] ~43-~43: If you want to indicate numerical ranges or time ranges, consider using an en dash. (DASH_RULE)
Context: ... inaccessible-by-default off`. Points 4 - 6 are shown below. 
Context: ... flash them to the target separately. If for some reason you don't want to do that, you can unch...
[typographical] ~56-~56: If you want to indicate numerical ranges or time ranges, consider using an en dash. (DASH_RULE)
Context: ...ote hardware-watchpoint-limit 2 Points 7 - 8 are shown below. 
Context: ...on entered under “Set break point at:”. Checkout this option and enter the name of the m...
[typographical] ~63-~63: If you want to indicate numerical ranges or time ranges, consider using an en dash. (DASH_RULE)
Context: ...eakpoint inserted at app_main. Points 9 - 11 are shown below. 
Context: ...your debug logs to an external file. To do this: * Go-to Common tab. * Under `Stan...
[misspelling] ~78-~78: This word is normally spelled as one. (EN_COMPOUNDS_AUTO_CONFIGURED)
Context: ...r OpenOCD Configuration OpenOCD path is auto-configured based on theOPENOCD_SCRIPTSpath def...
[uncategorized] ~92-~92: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... these steps: * On the top panel of the Eclipse click onWindow*Short View* Sele...
[typographical] ~98-~98: Consider adding a comma here. (PLEASE_COMMA)
Context: .../OpenOCDDebug_12.png) # Troubleshooting * Please make sure always have the [latest](http...
[style] ~99-~99: Consider using a different verb to strengthen your wording. (MAKE_SURE_ENSURE)
Context: ...bug_12.png) # Troubleshooting * Please make sure always have the [latest](https://github...
[typographical] ~101-~101: Consider adding a comma after ‘Usually’ for more clarity. (RB_LY_COMMA)
Context: ...&t=36164#p122701) from the preferences. Usually this happens while working with big siz...
[style] ~102-~102: Consider an alternative verb to strengthen your wording. (IF_YOU_HAVE_THIS_PROBLEM)
Context: ...ng with big size applications. * If you see any error while debugging, please check...
[style] ~103-~103: Consider an alternative verb to strengthen your wording. (IF_YOU_HAVE_THIS_PROBLEM)
Context: ...at helps to resolve the issue. * If you have any issue and want to enable OpenOCD de...README_CN.md
[uncategorized] ~163-~163: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"启动 (wb4)
Context: ...目时出现。 1. 点击顶部工具栏中左起第三个下拉窗口启动目标。 1. 选择新的启动目标。 1. 选择ESP 目标。 1. 提供目标属性，即您希望启动应...
[uncategorized] ~543-~543: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：新"地"更新 (wb4)
Context: ...则可以按照以下步骤获取更新。 1. 前往帮助>检查更新。 1. 如有新的更新，请选择乐鑫 IDF 插件，并取消勾选所有其他项目。 1. 点击`下一步...
[uncategorized] ~806-~806: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：最新"地"开发 (wb4)
Context: ...nsUsingLocalFile">介绍 进行安装。 # 如何获得最新的开发构建 1. 前往最新 master 分支，找到 <a href="http...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: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...dFinishyou will see the progress on console for the tools getting installed. Once t...
[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...
[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...
[uncategorized] ~137-~137: Possible missing article found. (AI_HYDRA_LEO_MISSING_THE)
Context: ...Activecolumn. The refresh button in last column for the active ESP-IDF version c...
[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...
[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: ...s_readme/images/icons/run.png) and it's auto-configured to flash the application with the defau...
[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...
[uncategorized] ~315-~315: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... in which you want to add the component to and SelectInstall ESP-IDF Components...
[uncategorized] ~321-~321: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ect. To get to the readme file for that component you can click onMore Infowhich will...
[uncategorized] ~324-~324: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... Already added components are also shown but theInstallbutton changes text to `A...
[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] ~400-~400: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...Changing Language To change the plugin language a menu is provided to show the list of ...
[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] ~547-~547: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...` in project root by double-clicking on it which will open the configuration edito...
[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] ~580-~580: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...debug_panic_mode.png) You can view the registers stack trace and even view the value of ...
[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] ~599-~599: It seems likely that a singular genitive (’s) apostrophe is missing. (AI_HYDRA_LEO_APOSTROPHE_S_XS)
Context: ...ion in the core dump. You can view the registers stack trace and even view the value of ...
[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...
[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:...
[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
docs_readme/Espressif-IDE.md
4-4: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
17-17: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
31-31: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
59-59: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
49-49: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
53-53: null (MD014, commands-show-output)
Dollar signs used before commands without showing output
3-3: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
8-8: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
46-46: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
55-55: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
55-55: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
8-8: Punctuation: ':' (MD026, no-trailing-punctuation)
Trailing punctuation in heading
48-48: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
50-50: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
52-52: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
54-54: null (MD031, blanks-around-fences)
Fenced code blocks should be surrounded by blank lines
9-9: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
56-56: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
48-48: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
52-52: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
6-6: null (MD045, no-alt-text)
Images should have alternate text (alt text)docs_readme/OpenOCD Debugging.md
10-10: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
17-17: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
21-21: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
24-24: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
74-74: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
76-76: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
103-103: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
53-53: Column: 1 (MD010, no-hard-tabs)
Hard tabs
54-54: Column: 1 (MD010, no-hard-tabs)
Hard tabs
55-55: Column: 1 (MD010, no-hard-tabs)
Hard tabs
15-15: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
105-105: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
3-3: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
24-24: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
24-24: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
34-34: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
77-77: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
81-81: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
98-98: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
77-77: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
81-81: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
98-98: null (MD025, single-title, single-h1)
Multiple top-level headings in the same document
5-5: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
17-17: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
25-25: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
55-55: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
69-69: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
92-92: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
99-99: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
46-46: null (MD034, no-bare-urls)
Bare URL used
13-13: null (MD045, no-alt-text)
Images should have alternate text (alt text)
23-23: null (MD045, no-alt-text)
Images should have alternate text (alt text)
32-32: null (MD045, no-alt-text)
Images should have alternate text (alt text)
44-44: null (MD045, no-alt-text)
Images should have alternate text (alt text)
57-57: null (MD045, no-alt-text)
Images should have alternate text (alt text)
64-64: null (MD045, no-alt-text)
Images should have alternate text (alt text)
75-75: null (MD045, no-alt-text)
Images should have alternate text (alt text)
80-80: null (MD045, no-alt-text)
Images should have alternate text (alt text)
85-85: null (MD045, no-alt-text)
Images should have alternate text (alt text)
89-89: null (MD045, no-alt-text)
Images should have alternate text (alt text)
96-96: null (MD045, no-alt-text)
Images should have alternate text (alt text)README_CN.md
202-202: Expected: h2; Actual: h3 (MD001, heading-increment)
Heading levels should only increment by one level at a time
352-352: Expected: h2; Actual: h5 (MD001, heading-increment)
Heading levels should only increment by one level at a time
352-352: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
355-355: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
358-358: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
361-361: Expected: atx; Actual: atx_closed (MD003, heading-style)
Heading style
286-286: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
287-287: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
644-644: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
645-645: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
658-658: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
659-659: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
660-660: Expected: asterisk; Actual: dash (MD004, ul-style)
Unordered list style
694-694: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
695-695: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
696-696: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
697-697: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
698-698: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
699-699: Expected: 2; Actual: 1 (MD007, ul-indent)
Unordered list indentation
91-91: Column: 1 (MD010, no-hard-tabs)
Hard tabs
92-92: Column: 1 (MD010, no-hard-tabs)
Hard tabs
93-93: Column: 1 (MD010, no-hard-tabs)
Hard tabs
94-94: Column: 1 (MD010, no-hard-tabs)
Hard tabs
95-95: Column: 1 (MD010, no-hard-tabs)
Hard tabs
96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs
382-382: Column: 1 (MD010, no-hard-tabs)
Hard tabs
383-383: Column: 1 (MD010, no-hard-tabs)
Hard tabs
384-384: 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
602-602: Column: 1 (MD010, no-hard-tabs)
Hard tabs
603-603: Column: 1 (MD010, no-hard-tabs)
Hard tabs
604-604: Column: 1 (MD010, no-hard-tabs)
Hard tabs
605-605: 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
694-694: Column: 1 (MD010, no-hard-tabs)
Hard tabs
695-695: Column: 1 (MD010, no-hard-tabs)
Hard tabs
696-696: Column: 1 (MD010, no-hard-tabs)
Hard tabs
697-697: Column: 1 (MD010, no-hard-tabs)
Hard tabs
698-698: Column: 1 (MD010, no-hard-tabs)
Hard tabs
699-699: Column: 1 (MD010, no-hard-tabs)
Hard tabs
737-737: Column: 1 (MD010, no-hard-tabs)
Hard tabs
739-739: Column: 1 (MD010, no-hard-tabs)
Hard tabs
741-741: 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
769-769: Column: 1 (MD010, no-hard-tabs)
Hard tabs
771-771: Column: 1 (MD010, no-hard-tabs)
Hard tabs
776-776: Column: 1 (MD010, no-hard-tabs)
Hard tabs
780-780: Column: 1 (MD010, no-hard-tabs)
Hard tabs
782-782: Column: 1 (MD010, no-hard-tabs)
Hard tabs
784-784: Column: 1 (MD010, no-hard-tabs)
Hard tabs
793-793: Column: 1 (MD010, no-hard-tabs)
Hard tabs
794-794: Column: 1 (MD010, no-hard-tabs)
Hard tabs
795-795: Column: 1 (MD010, no-hard-tabs)
Hard tabs
796-796: Column: 1 (MD010, no-hard-tabs)
Hard tabs
797-797: Column: 1 (MD010, no-hard-tabs)
Hard tabs
16-16: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
283-283: null (MD019, no-multiple-space-atx)
Multiple spaces after hash on atx style heading
373-373: null (MD019, no-multiple-space-atx)
Multiple spaces after hash on atx style heading
389-389: null (MD019, no-multiple-space-atx)
Multiple spaces after hash on atx style heading
518-518: null (MD019, no-multiple-space-atx)
Multiple spaces after hash on atx style heading
531-531: null (MD019, no-multiple-space-atx)
Multiple spaces after hash on atx style heading
549-549: null (MD019, no-multiple-space-atx)
Multiple spaces after hash on atx style heading
563-563: null (MD019, no-multiple-space-atx)
Multiple spaces after hash on atx style heading
21-21: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
67-67: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
104-104: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
144-144: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
158-158: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
170-170: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
181-181: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
190-190: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
211-211: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
224-224: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
239-239: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
258-258: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
272-272: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
283-283: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
305-305: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
319-319: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
335-335: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
352-352: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
355-355: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
358-358: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
361-361: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
373-373: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
389-389: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
403-403: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
416-416: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
434-434: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
448-448: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
506-506: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
518-518: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
531-531: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
549-549: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
563-563: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
577-577: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
640-640: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
674-674: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
717-717: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
726-726: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
752-752: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
816-816: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
817-817: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
831-831: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
853-853: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
761-761: 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
286-286: null (MD032, blanks-around-lists)
Lists should be surrounded by blank lines
93-93: null (MD034, no-bare-urls)
Bare URL used
94-94: null (MD034, no-bare-urls)
Bare URL used
95-95: null (MD034, no-bare-urls)
Bare URL used
520-520: null (MD034, no-bare-urls)
Bare URL used
537-537: null (MD034, no-bare-urls)
Bare URL used
296-296: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
300-300: null (MD036, no-emphasis-as-heading)
Emphasis used instead of a heading
595-595: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
602-602: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
756-756: null (MD040, fenced-code-language)
Fenced code blocks should have a language specified
793-793: 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)
101-101: null (MD045, no-alt-text)
Images should have alternate text (alt text)
121-121: null (MD045, no-alt-text)
Images should have alternate text (alt text)
137-137: null (MD045, no-alt-text)
Images should have alternate text (alt text)
141-141: null (MD045, no-alt-text)
Images should have alternate text (alt text)
155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)
167-167: 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)
200-200: null (MD045, no-alt-text)
Images should have alternate text (alt text)
236-236: 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)
249-249: null (MD045, no-alt-text)
Images should have alternate text (alt text)
252-252: null (MD045, no-alt-text)
Images should have alternate text (alt text)
255-255: 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)
276-276: null (MD045, no-alt-text)
Images should have alternate text (alt text)
280-280: null (MD045, no-alt-text)
Images should have alternate text (alt text)
298-298: null (MD045, no-alt-text)
Images should have alternate text (alt text)
302-302: null (MD045, no-alt-text)
Images should have alternate text (alt text)
316-316: null (MD045, no-alt-text)
Images should have alternate text (alt text)
325-325: null (MD045, no-alt-text)
Images should have alternate text (alt text)
330-330: null (MD045, no-alt-text)
Images should have alternate text (alt text)
364-364: null (MD045, no-alt-text)
Images should have alternate text (alt text)
386-386: null (MD045, no-alt-text)
Images should have alternate text (alt text)
400-400: null (MD045, no-alt-text)
Images should have alternate text (alt text)
429-429: null (MD045, no-alt-text)
Images should have alternate text (alt text)
431-431: null (MD045, no-alt-text)
Images should have alternate text (alt text)
443-443: null (MD045, no-alt-text)
Images should have alternate text (alt text)
477-477: null (MD045, no-alt-text)
Images should have alternate text (alt text)
485-485: null (MD045, no-alt-text)
Images should have alternate text (alt text)
499-499: null (MD045, no-alt-text)
Images should have alternate text (alt text)
515-515: null (MD045, no-alt-text)
Images should have alternate text (alt text)
528-528: null (MD045, no-alt-text)
Images should have alternate text (alt text)
546-546: null (MD045, no-alt-text)
Images should have alternate text (alt text)
560-560: null (MD045, no-alt-text)
Images should have alternate text (alt text)
584-584: null (MD045, no-alt-text)
Images should have alternate text (alt text)
587-587: null (MD045, no-alt-text)
Images should have alternate text (alt text)
608-608: null (MD045, no-alt-text)
Images should have alternate text (alt text)
614-614: null (MD045, no-alt-text)
Images should have alternate text (alt text)
631-631: 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)
682-682: null (MD045, no-alt-text)
Images should have alternate text (alt text)
686-686: null (MD045, no-alt-text)
Images should have alternate text (alt text)
703-703: null (MD045, no-alt-text)
Images should have alternate text (alt text)
714-714: null (MD045, no-alt-text)
Images should have alternate text (alt text)
828-828: null (MD045, no-alt-text)
Images should have alternate text (alt text)
855-855: null (MD047, single-trailing-newline)
Files should end with a single newline character
844-844: Expected: leading_and_trailing; Actual: trailing_only; Missing leading pipe (MD055, table-pipe-style)
Table pipe style
846-846: Expected: 5; Actual: 4; Too few cells, row will be missing data (MD056, table-column-count)
Table column countREADME.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 (12)
README_CN.md (1)
81-81: Ensure the updated link points to the correct location in the newdocs_readmedirectory structure.Verification successful
The link in the README_CN.md file correctly points to the existing Espressif-IDE.md file in the docs_readme directory.
- README_CN.md: Line 81
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the link points to the correct location. # Test: Search for the link usage. Expect: Only occurances of the new link. rg --type markdown $'https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/Espressif-IDE.md'Length of output: 711
Script:
#!/bin/bash # Description: Verify if the target file exists in the specified location. # Test: Check if the file Espressif-IDE.md exists in the docs_readme directory. if [ -f "docs_readme/Espressif-IDE.md" ]; then echo "File exists" else echo "File does not exist" fiLength of output: 74
README.md (11)
12-14: The image paths have been updated to reflect the new directory structure. Ensure that the new paths are accessible and the images are correctly displayed in the documentation.Tools
Markdownlint
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)
Line range hint
108-133: Images and links within the ESP-IDF Manager documentation section have been updated. Confirm that all resources are correctly linked and displayed.Tools
LanguageTool
[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...Markdownlint
111-111: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
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)
Line range hint
153-168: The image path for the new project creation screenshot has been updated. Ensure this image is correctly placed in thedocs_readmedirectory and is displaying as intended.Tools
Markdownlint
156-156: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
153-153: null (MD045, no-alt-text)
Images should have alternate text (alt text)
177-190: The build and flash process documentation has been updated with new image paths. Double-check that these images are available and render correctly in the document.Tools
LanguageTool
[misspelling] ~184-~184: This word is normally spelled as one. (EN_COMPOUNDS_AUTO_CONFIGURED)
Context: ...s_readme/images/icons/run.png) and it's auto-configured to flash the application with the defau...Markdownlint
182-182: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
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)
Line range hint
205-229: Updated the serial terminal and debugging sections with new image paths. It's crucial to ensure these images are properly linked and accessible.Tools
LanguageTool
[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...Markdownlint
228-228: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
224-224: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Line range hint
246-261: The section on creating new projects using templates has been updated with new image paths. Confirm the accuracy and availability of these images.Tools
Markdownlint
248-248: Expected: 1; Actual: 2 (MD012, no-multiple-blanks)
Multiple consecutive blank lines
246-246: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Line range hint
308-322: The ESP-IDF Terminal and component installation sections have been updated. Verify that all components and functionalities are correctly documented and the images are displayed properly.Tools
LanguageTool
[uncategorized] ~315-~315: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... in which you want to add the component to and SelectInstall ESP-IDF Components...
[uncategorized] ~321-~321: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...ect. To get to the readme file for that component you can click onMore Infowhich will...
[uncategorized] ~324-~324: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... Already added components are also shown but theInstallbutton changes text to `A...Markdownlint
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)
Line range hint
331-367: Updates to the environment and toolchain configuration sections include new image paths. Ensure these changes are correctly implemented and the images are accessible.Tools
Markdownlint
350-350: Column: 1 (MD010, no-hard-tabs)
Hard tabs
351-351: Column: 1 (MD010, no-hard-tabs)
Hard tabs
356-356: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
353-353: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Line range hint
393-407: The language change functionality documentation has been updated. Check that the new documentation accurately reflects the functionality and the images are displayed correctly.Tools
Markdownlint
398-398: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
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)
Line range hint
678-792: The application-level tracing and custom build directory sections have been updated. Verify that the documentation is clear and the images are correctly linked.Tools
Markdownlint
681-681: Expected: 1; Actual: 0; Above (MD022, blanks-around-headings)
Headings should be surrounded by blank lines
678-678: null (MD045, no-alt-text)
Images should have alternate text (alt text)
71-74: The installation instructions have been updated to point to the newdocs_readmedirectory. Verify that the linked documents exist at the new location to avoid broken links.Verification successful
The linked documents 'Espressif-IDE-Windows-Installer.md' and 'Espressif-IDE.md' exist in the 'docs_readme' directory. Therefore, the links in the README.md file are valid.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of linked documents in the new location. # Test: Check for the existence of 'Espressif-IDE-Windows-Installer.md' and 'Espressif-IDE.md'. fd --type file "Espressif-IDE-Windows-Installer.md" "docs_readme" fd --type file "Espressif-IDE.md" "docs_readme"Length of output: 185
Tools
LanguageTool
[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...Markdownlint
73-73: Expected: 1; Actual: 0; Below (MD022, blanks-around-headings)
Headings 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
| @@ -100,5 +100,5 @@ You can customize the `Debug perspective` in your own way, for example, move som | |||
| * Please [check](https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-guides/jtag-debugging/index.html#selecting-jtag-adapter) if the board is having JTAG enabled. | |||
| * If there is any OpenOCD timeout issue, please [increase the GDB server timeout value](https://www.esp32.com/viewtopic.php?f=40&t=36164#p122701) from the preferences. Usually this happens while working with big size applications. | |||
| * If you see any error while debugging, please check this [OpenOCD troubleshooting FAQ guide](https://github.com/espressif/openocd-esp32/wiki/Troubleshooting-FAQ) and see if that helps to resolve the issue. | |||
| * If you have any issue and want to enable OpenOCD debugging verbose, please check [Enable verbose output](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs/OpenOCD%20Debugging.md#startup-tab) option from the startup tab. | |||
| * If you have any issue and want to enable OpenOCD debugging verbose, please check [Enable verbose output](https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/OpenOCD%20Debugging.md#startup-tab) option from the startup tab. | |||
There was a problem hiding this comment.
Tip
Codebase Verification
The link provided in the documentation points to a non-existent page, resulting in a 404 error. The correct section "Enable verbose output" exists within the same file (docs_readme/OpenOCD Debugging.md), but the anchor link is incorrect.
- Update the link to point to the correct section within the same file.
Analysis chain
The link has been updated to point to the new documentation directory. Ensure that the new link is accessible and the content at the new location is updated to reflect any changes.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the accessibility of the new documentation link.
# Test: Check if the new documentation link is accessible.
curl -o /dev/null -s -w "%{http_code}\n" https://github.com/espressif/idf-eclipse-plugin/blob/master/docs_readme/OpenOCD%20Debugging.md#startup-tab
Length of output: 153
Script:
#!/bin/bash
# Description: Search for the "Enable verbose output" section within the repository to find the correct link.
# Search for the "Enable verbose output" section in markdown files.
rg "Enable verbose output" --glob "*.md"
Length of output: 715
Tools
LanguageTool
[style] ~103-~103: Consider an alternative verb to strengthen your wording. (IF_YOU_HAVE_THIS_PROBLEM)
Context: ...at helps to resolve the issue. * If you have any issue and want to enable OpenOCD de...
Markdownlint
103-103: Expected: 0 or 2; Actual: 1 (MD009, no-trailing-spaces)
Trailing spaces
| @@ -152,7 +152,7 @@ ESP-IDF 目录选择对话框： | |||
|
|
|||
| > **Note:** 完成以上操作后，您将在编辑器中看到许多未解决的 include 错误。这些错误仅在构建完成后才能解决。 | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
|  | |
|  |
Tools
Markdownlint
155-155: null (MD045, no-alt-text)
Images should have alternate text (alt text)
|
|
||
| <a name="cmakeproject"></a> | ||
| # CMake 编辑器 | ||
|
|
||
| ESP-IDF Eclipse 插件中还集成了一个 CMake 编辑器，允许用户编辑 CMakeList.txt 等 CMake 文件，支持语法高亮、CMake 命令助手、代码模板等功能。 | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
|  | |
|  |
Tools
Markdownlint
276-276: null (MD045, no-alt-text)
Images should have alternate text (alt text)
| @@ -295,11 +295,11 @@ | |||
|
|
|||
| **应用程序内存分析 - 概述** | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
|  | |
|  |
Tools
Markdownlint
298-298: null (MD045, no-alt-text)
Images should have alternate text (alt text)
| @@ -118,7 +118,7 @@ | |||
|
|
|||
| 本操作将下载指定的 ESP-IDF 版本，并配置 Eclipse CDT 构建环境变量中的 `IDF_PATH`。 | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
|  | |
|  |
Tools
Markdownlint
121-121: null (MD045, no-alt-text)
Images should have alternate text (alt text)
| @@ -197,7 +197,7 @@ | |||
| 1. 配置`串口监视器`过滤器，对串口输出进行过滤。 | |||
| 1. 点击 `OK` 启动终端，开始监听 USB 端口。 | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ Tools
Markdownlint
200-200: null (MD045, no-alt-text)
Images should have alternate text (alt text)
|
|
||
| 1. 展开 `Component Config` 部分，并选择 `ESP System Settings`；窗口右侧在 `Panic handler behaviour` 中选择 `GDBStub on Panic`。 | ||
|  | ||
|  |
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ Tools
Markdownlint
587-587: null (MD045, no-alt-text)
Images should have alternate text (alt text)
|
|
||
| 启动应用层追踪功能之前，请首先完成项目的调试配置，包括指定使用的开发板名称。否则无法正常启动 OpenOCD 服务器。 | ||
|
|
||
|  | ||
|  |
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ Tools
Markdownlint
682-682: null (MD045, no-alt-text)
Images should have alternate text (alt text)
| @@ -605,13 +605,13 @@ | |||
| ``` | |||
|
|
|||
| 最终文件实例： | |||
|  | |||
|  | |||
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ Tools
Markdownlint
608-608: null (MD045, no-alt-text)
Images should have alternate text (alt text)
| @@ -397,7 +397,7 @@ | |||
|
|
|||
| > **Note:** Eclipse CDT 在保存工具链偏好设置时有一个已知 bug。因此，我们建议在进行后续操作前，重新启动 Eclipse。 | |||
|
|
|||
|  | |||
|  | |||
There was a problem hiding this comment.
Please add alt text to the image for better accessibility.
- 
+ Tools
Markdownlint
400-400: null (MD045, no-alt-text)
Images should have alternate text (alt text)
Will use docs folder for creating docs which can be published to docs.espressif.com/espressif-ide
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