docs: update docs_readme references (IEP-1388) #1100
Conversation
Signed-off-by: Emmanuel Ferdman <[email protected]>
WalkthroughThis pull request involves updating documentation paths and correcting minor typographical errors across two files. The primary changes include redirecting documentation links from the Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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 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
🧹 Nitpick comments (2)
FAQ.md (2)
140-142: Improve readability with proper punctuationThe explanation is technically accurate but could benefit from better punctuation:
-esp_idf_components folder is introduced with v2.4.0 release to achieve source code navigation for the function definitions((Press F3 or Ctrl+Click on the functional call) and to fix unresolved header problems with the indexer. It will be created immediately after the build based on the build/compile_commands.json file list. secondly, it also helps the users who want to check source of esp-idf components directly from the IDE. The files created under esp_idf_components are virtual folders for /esp-idf/components and these will be re-generated everytime after the build. +The esp_idf_components folder is introduced with v2.4.0 release to achieve source code navigation for the function definitions (Press F3 or Ctrl+Click on the functional call) and to fix unresolved header problems with the indexer. It will be created immediately after the build based on the build/compile_commands.json file list. Secondly, it also helps users who want to check source of esp-idf components directly from the IDE. The files created under esp_idf_components are virtual folders for /esp-idf/components, and these will be re-generated every time after the build. -This could be disabled by adding the -Dskip.idf.components=true VM argument in the eclipse.ini(espressif-ide.ini) file but this might create inconsistency issues with the indexer where it's unable to resolve headers properly and you might not be able to navigate to the function definitions from the code editors. +This could be disabled by adding the -Dskip.idf.components=true VM argument in the eclipse.ini (espressif-ide.ini) file, but this might create inconsistency issues with the indexer where it's unable to resolve headers properly, and you might not be able to navigate to the function definitions from the code editors.🧰 Tools
🪛 LanguageTool
[uncategorized] ~140-~140: Possible missing comma found.
Context: ...onents are virtual folders for /esp-idf/components and these will be re-generated everytim...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~142-~142: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the eclipse.ini(espressif-ide.ini) file but this might create inconsistency issues ...(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~142-~142: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... it's unable to resolve headers properly and you might not be able to navigate to th...(COMMA_COMPOUND_SENTENCE)
175-175: Add alt text to images for accessibilityPlease add descriptive alt text to the images to improve accessibility:
- + - +Also applies to: 214-214
🧰 Tools
🪛 Markdownlint (0.37.0)
175-175: null
Images should have alternate text (alt text)(MD045, no-alt-text)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
FAQ.md(6 hunks)bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- bundles/com.espressif.idf.ui/src/com/espressif/idf/ui/tools/messages.properties
🧰 Additional context used
🪛 LanguageTool
FAQ.md
[typographical] ~21-~21: Consider adding a comma here.
Context: ... Windows - macOSX - Linux For downloads please check this [here](https://github.com/es...
(PLEASE_COMMA)
[uncategorized] ~140-~140: Possible missing comma found.
Context: ...onents are virtual folders for /esp-idf/components and these will be re-generated everytim...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~142-~142: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... the eclipse.ini(espressif-ide.ini) file but this might create inconsistency issues ...
(COMMA_COMPOUND_SENTENCE_2)
[uncategorized] ~142-~142: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... it's unable to resolve headers properly and you might not be able to navigate to th...
(COMMA_COMPOUND_SENTENCE)
🪛 Markdownlint (0.37.0)
FAQ.md
175-175: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
214-214: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
FAQ.md (1)
21-21: LGTM: Documentation path correctly updated
The path update from docs/ to docs_readme/ aligns with the documentation relocation mentioned in the PR objectives.
🧰 Tools
🪛 LanguageTool
[typographical] ~21-~21: Consider adding a comma here.
Context: ... Windows - macOSX - Linux For downloads please check this [here](https://github.com/es...
(PLEASE_COMMA)
github-actions
bot
changed the title
|
@kolipakakondal please review this small PR when you get the chance 🙌 |
Description
Commit ebbf7de moved some of docs file to
docs_readme. This PR adjusts sources to changes.Fixes
Type of change
Please delete options that are not relevant.
How has this been tested?
Dependent components impacted by this PR:
Checklist
Summary by CodeRabbit
Documentation
User Interface