docs: cleanup github readme docs

[kolipakakondal]

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.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

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 A
• Test B

Test Configuration:

• ESP-IDF Version:
• OS (Windows,Linux and macOS):

Dependent components impacted by this PR:

• Component 1
• Component 2

Checklist

• PR Self Reviewed
• Applied Code formatting
• Added Documentation
• Added Unit Test
• Verified on all platforms - Windows,Linux and macOS

Summary by CodeRabbit

• Documentation
  • Improved clarity and organization of the README.md file.
  • Updated title to emphasize "Espressif-IDE" and its function.
  • Clarified version compatibility for ESP-IDF.
  • Restructured sections for better flow, including installation and troubleshooting guides.
  • Updated prerequisites to specify Java 17+.
  • Revised section titles for enhanced readability.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on enhancing the README.md file for the Espressif-IDE. Key modifications include rephrasing and restructuring content for better clarity and consistency, updating version compatibility notes, and revising section titles for improved readability. The prerequisites for building locally have been updated to specify Java 17+, and links to documentation have been refreshed to reflect the latest resources. Overall, the changes aim to improve the organization and accuracy of the documentation.

Changes

File	Change Summary
README.md	- Title changed to emphasize "Espressif-IDE" first. - Section titles updated for clarity. - Prerequisites updated from Java 11+ to Java 17+. - Installation and troubleshooting sections restructured. - Links to documentation updated.

Possibly related PRs

• Documentation for ESP-IDF Manager view and some minor fixes #953: Updates installation instructions for ESP-IDF in the Espressif IDE, relating to clarity improvements.
• Update docs #978: Corrects typos and updates installation instructions in the README.md, aligning with the main PR's focus.
• Update README.md #1066: Includes minor formatting adjustments to the README.md, related to enhancing documentation clarity.
• IEP-1279 Verify clangd editor features and find the gaps #1069: Adds a new section regarding the LSP Editor, complementing the updates aimed at improving documentation structure.

Suggested labels

needs translation:CN

Suggested reviewers

• AndriiFilippov
• sigmaaa

Poem

🐰 In the garden of code, we hop and play,
With clearer paths, we find our way.
Espressif-IDE shines so bright,
With updates and links, it feels just right.
So let’s build and create, with joy in our hearts,
For every change, a new journey starts! 🌼

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.