Skip to content

IEP-1706 GH #1398: Missing installer for Windows v4.x releases#1456

Merged
kolipakakondal merged 1 commit intomasterfrom
IEP-1706
May 6, 2026
Merged

IEP-1706 GH #1398: Missing installer for Windows v4.x releases#1456
kolipakakondal merged 1 commit intomasterfrom
IEP-1706

Conversation

@sigmaaa
Copy link
Copy Markdown
Collaborator

@sigmaaa sigmaaa commented May 6, 2026

Description

Updated the outdated installation doc section to not confuse users

Fixes # (IEP-1706)

Type of change

Please delete options that are not relevant.

  • New feature (non-breaking change which adds functionality)

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
    • Restructured the installation guide by consolidating separate platform-specific instructions for Windows, macOS, and Linux into a unified section.
    • Simplified documentation layout while maintaining all essential installation steps for improved clarity and ease of navigation.

@sigmaaa sigmaaa added this to the v4.2.1 milestone May 6, 2026
@sigmaaa sigmaaa self-assigned this May 6, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 6, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: db19ee6d-4e20-4cdc-acb3-649fb7485eed

📥 Commits

Reviewing files that changed from the base of the PR and between 18a8fa0 and 3c676eb.

📒 Files selected for processing (1)
  • docs/en/installation.rst

📝 Walkthrough

Walkthrough

The installation documentation is restructured to consolidate separate Windows and macOS/Linux subsections into a single unified "Windows/macOS/Linux" subsection header, with the Windows-specific offline-installer note removed.

Changes

Documentation Restructuring

Layer / File(s) Summary
Installation Guide Update
docs/en/installation.rst
Subsection headers consolidated from separate Windows and macOS/Linux sections into single "Windows/macOS/Linux" header; Windows offline-installer note removed.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

needs translation:CN

Suggested reviewers

  • AndriiFilippov
  • kolipakakondal

Poem

A rabbit hops through docs with glee,
Consolidating for clarity—
Windows and Mac now unite,
Under one header, all just right! 🐰✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Title check ⚠️ Warning The PR title mentions 'Missing installer for Windows v4.x releases' but the actual changes only involve documentation restructuring of the installation guide, not addressing a missing installer issue. Revise the title to accurately reflect the documentation update, such as 'Restructure installation documentation for clarity' or 'Consolidate Windows/macOS/Linux installation instructions'.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch IEP-1706

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@AndriiFilippov
Copy link
Copy Markdown
Collaborator

LGTM 👍

@kolipakakondal kolipakakondal merged commit f0537fc into master May 6, 2026
4 of 8 checks passed
@kolipakakondal kolipakakondal deleted the IEP-1706 branch May 6, 2026 12:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants