Skip to content

IEP-1687 Verify all the screenshots in the IDE document and Update#1405

Open
sigmaaa wants to merge 4 commits intomasterfrom
IEP-1687
Open

IEP-1687 Verify all the screenshots in the IDE document and Update#1405
sigmaaa wants to merge 4 commits intomasterfrom
IEP-1687

Conversation

@sigmaaa
Copy link
Collaborator

@sigmaaa sigmaaa commented Feb 25, 2026

Description

Updated screenshots in the documentation

Fixes # (IEP-1687)

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How has this been tested?

check the updated doc

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
    • Switched DFU docs to use bundled/local images instead of external URLs.
    • Updated NVS Partition Editor docs to reference bundled/local images instead of external URLs.
    • Added a new "Charts" figure to the Application Size Analysis docs to illustrate memory-usage visualizations.

@sigmaaa sigmaaa self-assigned this Feb 25, 2026
@coderabbitai
Copy link

coderabbitai bot commented Feb 25, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Replaced external image URLs with local media paths in DFU and NVS Partition Editor docs, and added a new "Charts" figure under Overview in the Application Size Analysis doc.

Changes

Cohort / File(s) Summary
Documentation image path updates
docs/en/additionalfeatures/dfu.rst, docs/en/additionalfeatures/nvspartitioneditor.rst
Replaced external image URLs with local media paths (../../../media/dfu/dfu_1.png, ../../../media/NvsEditor/nvs_1.png, ../../../media/NvsEditor/nvs_2.png, ../../../media/NvsEditor/nvs_3.png). No code or logic changes.
Application Size Analysis docs
docs/en/additionalfeatures/application-size-analysis.rst
Inserted a new "Charts" figure (size_charts.png) with center alignment and caption "Application Size Analysis – Charts"; adjusted section layout. No functional changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • AndriiFilippov
  • alirana01

Poem

🐰 I hopped through docs with a nimble beat,

Swapped distant images for folders neat.
Charts now perched tidy, pictures close and bright,
Quietly nesting, safe from the byte. 🥕✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title references the ticket number (IEP-1687) and indicates the change is about verifying and updating screenshots in IDE documentation, which aligns with the actual changes made.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ 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-1687
📝 Coding Plan
  • Generate coding plan for human review comments

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.

Tip

You can validate your CodeRabbit configuration file in your editor.

If your editor has YAML language server, you can enable auto-completion and validation by adding # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json at the top of your CodeRabbit configuration file.

@sigmaaa sigmaaa changed the title WIP: IEP-1687 Verify all the screenshots in the IDE document and Update IEP-1687 Verify all the screenshots in the IDE document and Update Mar 1, 2026
Copy link
Collaborator

@kolipakakondal kolipakakondal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/en/additionalfeatures/application-size-analysis.rst`:
- Around line 9-10: Update the intro sentence that currently reads "It has two
sections:" to reflect the added Charts section by changing it to "It has three
sections:" so it matches the subsequent bulleted list (the sentence containing
"It has two sections:" in application-size-analysis.rst).

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 731a7497-a26f-4926-b393-e45cde881e0f

📥 Commits

Reviewing files that changed from the base of the PR and between d41cff6 and 01f5e21.

⛔ Files ignored due to path filters (4)
  • media/change_language.png is excluded by !**/*.png
  • media/size_charts.png is excluded by !**/*.png
  • media/sizeanalysis_details.png is excluded by !**/*.png
  • media/sizeanalysis_overview.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • docs/en/additionalfeatures/application-size-analysis.rst

@AndriiFilippov
Copy link
Collaborator

@sigmaaa hi

https://docs.espressif.com/projects/espressif-ide/en/latest/additionalfeatures/appleveltracing.html

there is no example called "app_trace_to_host" anymore.
image

quite old Debugger illustration:
image

https://docs.espressif.com/projects/espressif-ide/en/latest/openocddebugging.html
quite old Debugger illustration as well

https://docs.espressif.com/projects/espressif-ide/en/latest/monitoroutput.html
now we have updated "Launch Terminal" shell
image

@sigmaaa
Copy link
Collaborator Author

sigmaaa commented Mar 18, 2026

Hi @AndriiFilippov,

Thanks for the review. Our documentation mentions that app_trace_to_host was renamed in ESP-IDF version 5.1, so I think this is fine.

I’ve updated the debugging and terminal screenshots. Thanks again!

Copy link
Collaborator

@kolipakakondal kolipakakondal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@kolipakakondal kolipakakondal added this to the v4.2.0 milestone Mar 20, 2026
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