Adding preview targets in the IDE #1237
Conversation
WalkthroughA new documentation file was added, providing step-by-step instructions for configuring custom or preview ESP-IDF targets in the IDE. Additionally, the build project documentation was updated to include a reference to this new guide and to correct the formatting of an existing reference entry. Changes
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration 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
🧹 Nitpick comments (4)
docs/en/additionalfeatures/configuretoolchain.rst (2)
1-3: Verify title underline lengthEnsure the sequence of
=on line 2 matches or exceeds the length of the title on line 1, or the RST parser may misinterpret the section.
19-20: Leveragefigurefor captionsUsing
.. figure::with:caption:yields built-in caption support and better semantics than an italicized paragraph following.. image::.docs/en/buildproject.rst (2)
43-44: Maintain alphabetical order in ReferencesFor consistency, consider placing “Add a Preview or Custom ESP-IDF Target” before “Configure CDT Build Environment Variables” in the toctree.
45-45: Remove trailing whitespaceLine 45 contains only indentation; deleting it will clean up formatting and avoid formatting linter warnings.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
media/toolchain/toolchain_1.pngis excluded by!**/*.pngmedia/toolchain/toolchain_2.pngis excluded by!**/*.pngmedia/toolchain/toolchain_3.pngis excluded by!**/*.pngmedia/toolchain/toolchain_4.pngis excluded by!**/*.png
📒 Files selected for processing (2)
docs/en/additionalfeatures/configuretoolchain.rst(1 hunks)docs/en/buildproject.rst(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: build
- GitHub Check: Build Espressif-IDE Docs
- GitHub Check: build_macos
| .. image:: ../../../media/toolchain/toolchain_1.png | ||
| :alt: Core Build Toolchains Preferences (Add Custom Target) | ||
|
|
There was a problem hiding this comment.
Invalid image paths will break docs build
The relative paths for your screenshots are off by one directory; from docs/en/additionalfeatures, you should use ../../media/... instead of ../../../media/....
--- a/docs/en/additionalfeatures/configuretoolchain.rst
+++ b/docs/en/additionalfeatures/configuretoolchain.rst
@@ -16,3 +16,3 @@
-.. image:: ../../../media/toolchain/toolchain_1.png
- :alt: Core Build Toolchains Preferences (Add Custom Target)
+.. image:: ../../media/toolchain/toolchain_1.png
+ :alt: Core Build Toolchains Preferences (Add Custom Target)
@@ -29,3 +29,3 @@
-.. image:: ../../../media/toolchain/toolchain_2.png
- :alt: CMake Toolchain Preferences (Add Custom Target)
+.. image:: ../../media/toolchain/toolchain_2.png
+ :alt: CMake Toolchain Preferences (Add Custom Target)
@@ -43,3 +43,3 @@
-.. image:: ../../../media/toolchain/toolchain_3.png
- :alt: New ESP Target Dialog (Custom Target Example)
+.. image:: ../../media/toolchain/toolchain_3.png
+ :alt: New ESP Target Dialog (Custom Target Example)
@@ -54,3 +54,3 @@
-.. image:: ../../../media/toolchain/toolchain_4.png
- :alt: Build Output for Custom Target Project
+.. image:: ../../media/toolchain/toolchain_4.png
+ :alt: Build Output for Custom Target ProjectAlso applies to: 29-31, 43-44, 54-55
🤖 Prompt for AI Agents
In docs/en/additionalfeatures/configuretoolchain.rst around lines 16 to 18, the
relative image paths are incorrect and cause the docs build to break. Change the
image paths from '../../../media/...' to '../../media/...' to correctly
reference the media directory relative to the current file. Also update the same
path correction for lines 29-31, 43-44, and 54-55.
Description
Adding preview targets in the IDE
https://esp32.com/viewtopic.php?t=45765
Fixes # (IEP-1551)
Type of change
How has this been tested?
NA
Test Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit