fix: Update the new docs link #1095
Conversation
WalkthroughThe pull request modifies the Changes
Possibly related PRs
Suggested reviewers
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 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: 0
🧹 Outside diff range and nitpick comments (1)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/help/EclipsePluginDocHandler.java (1)
44-44: Consider externalizing the documentation URLThe hardcoded URL could be moved to a configuration file or constant to make it easier to update in the future and maintain consistency across the plugin.
Consider creating a constants file or using Eclipse's preference system:
- return new URL("https://docs.espressif.com/projects/espressif-ide/en/latest/index.html"); //$NON-NLS-1$ + return new URL(IDFDocumentationConstants.ESPRESSIF_IDE_DOCS_URL); //$NON-NLS-1$
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/help/EclipsePluginDocHandler.java(1 hunks)
🔇 Additional comments (2)
bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/help/EclipsePluginDocHandler.java (2)
Line range hint 26-36: Integration with browser handling looks good
The execute() method properly handles the URL change with appropriate error handling and logging.
44-44: Verify the new documentation URL accessibility
The URL change from GitHub to the official Espressif documentation site looks good. The HTTPS protocol ensures secure access.
Let's verify the URL accessibility and check for any redirects:
✅ Verification successful
Documentation URL is accessible and secure
The new documentation URL is valid, accessible (HTTP 200), and properly configured:
- Serves over HTTPS with HSTS security header
- Points to the latest official documentation
- Hosted on Espressif's documentation server
- Content is properly cached and maintained (last modified Nov 14, 2024)
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the new documentation URL
curl -I https://docs.espressif.com/projects/espressif-ide/en/latest/index.html
Length of output: 840
|
@kolipakakondal hi ! Tested under: correct link https://docs.espressif.com/projects/espressif-ide/en/latest/index.html. ✅ LGTM 👍 |
Description
Please include a summary of the change and which issue is fixed.
Fixes # (IEP-1384)
Type of change
Please delete options that are not relevant.
How has this been tested?
Navigate to Help > ESP-IDF Eclipse Plugin and that should take you to the new documentation link https://docs.espressif.com/projects/espressif-ide/en/latest/index.html
Test Configuration:
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit
New Features
Bug Fixes