feat: updated marketplaceupdate_doc #1208
Conversation
WalkthroughThe documentation for the Espressif-IDE Eclipse Plugin update process was revised. A new reference entry, Changes
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:
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 (1)
docs/en/marketplaceupdate.rst (1)
97-101: Match the underline length to the heading text (nitpick)
For consistency, consider matching the number of hyphens in the underline exactly to the length of the heading text (Upgrading from Espressif-IDE 3.3.0 to 3.4.0). While Sphinx allows an underline that’s equal or longer, matching lengths improves readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/en/marketplaceupdate.rst(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build_macos
- GitHub Check: build
🔇 Additional comments (1)
docs/en/marketplaceupdate.rst (1)
12-12: Verify inclusion of the new upgrade topic in the section list
The new entry (:ref:upgradeEspressifIdeDependencies``) has been correctly added to the list of upgrade-related topics and matches the later anchor.
| 1. Click **Show original error and build my own solution**. | ||
| 2. Then select both: | ||
|
|
||
| - Update items already installed | ||
| - Remove items already installed | ||
| - **Update items already installed** | ||
| - **Remove items already installed** |
There was a problem hiding this comment.
Nest and format UI action items correctly
- The bullet items under step 2 are not indented, so they won’t be rendered as a nested list. Reindent by at least three spaces under
2.. - Use inline literals (
Show original error and build my own solution,Update items already installed,Remove items already installed) instead of bold text to align with the formatting used for UI elements elsewhere.
Example diff:
2. Then select both:
- - **Update items already installed**
- - **Remove items already installed**
+ - ``Update items already installed``
+ - ``Remove items already installed``📝 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.
| 1. Click **Show original error and build my own solution**. | |
| 2. Then select both: | |
| - Update items already installed | |
| - Remove items already installed | |
| - **Update items already installed** | |
| - **Remove items already installed** | |
| 1. Click **Show original error and build my own solution**. | |
| 2. Then select both: | |
| - ``Update items already installed`` | |
| - ``Remove items already installed`` |
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