Skip to content

Cover latest changes in README#1020

Merged
egorikftp merged 1 commit into
mainfrom
task/docs
Jul 2, 2026
Merged

Cover latest changes in README#1020
egorikftp merged 1 commit into
mainfrom
task/docs

Conversation

@egorikftp

Copy link
Copy Markdown
Member

📝 Changelog

If this PR introduces user-facing changes, please update the relevant Unreleased section in changelogs:

@egorikftp

Copy link
Copy Markdown
Member Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

This pull request updates README.md documentation only. Changes include adding a "Web app (under development)" entry to the tools list, expanding the table of contents with additional IDEA Plugin sections, rewriting the IDEA Plugin features description covering Simple mode, IconPack mode, Web Import, and SVG/XML conversion tools, adding a "Key options" table for the svgxml2imagevector CLI command, adjusting the Gradle plugin compatibility table, and adding documentation for the usePathDataString configuration option.

Changes

Cohort / File Summary
README.md Added Web app entry and expanded table of contents; rewrote IDEA Plugin feature descriptions (Simple mode, IconPack mode, Web Import, SVG/XML tools, ImageVector previewer variants); added CLI Key options table for svgxml2imagevector; updated Gradle plugin compatibility table; added usePathDataString option to Gradle configuration example

Sequence Diagram(s)

Not applicable — changes are limited to documentation content.

Related Issues: Not specified in the provided context.

Related PRs: Not specified in the provided context.

Suggested labels: documentation

Suggested reviewers: Not specified in the provided context.

Poem: A rabbit hopped through README's page, / Adding words for a new plugin stage, / Tables of options, neat and true, / Web apps and IconPacks in full view, / Docs now shine—hop, hop, hooray!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Linked Issues check ❓ Inconclusive The summary suggests README documentation updates, but the required screenshots are in excluded PNGs and the common SDK/parity-table sections are not clearly shown. Share the full README diff and the excluded image updates so the Material Symbols demo, redesigned screenshots, common SDK section, and parity table can be verified.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the README update.
Description check ✅ Passed The description follows the required changelog template and includes the issue reference.
Out of Scope Changes check ✅ Passed The changes stay within README documentation and related tables/examples, with no clearly unrelated code changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch task/docs

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.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 117-303: Add descriptive alt text to every new screenshot image in
the README’s feature sections so the markdown passes MD045 and is accessible;
update each `<img>` tag in the Simple mode, IconPack mode, Web Import, SVG to
XML, ImageVector to XML, and ImageVector Previewer sections with a concise
description that matches the screenshot content.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: 89d69f67-b0b2-4704-82e1-3e4ee5cfd6e1

📥 Commits

Reviewing files that changed from the base of the PR and between adc9883 and ba5a9bc.

⛔ Files ignored due to path filters (17)
  • assets/iconpack_mode.png is excluded by !**/*.png
  • assets/iconpack_mode_existing_1.png is excluded by !**/*.png
  • assets/iconpack_mode_existing_2.png is excluded by !**/*.png
  • assets/iconpack_mode_existing_3.png is excluded by !**/*.png
  • assets/iconpack_mode_material_1.png is excluded by !**/*.png
  • assets/iconpack_mode_material_2.png is excluded by !**/*.png
  • assets/iconpack_mode_material_3.png is excluded by !**/*.png
  • assets/iconpack_mode_new_1.png is excluded by !**/*.png
  • assets/iconpack_mode_new_2.png is excluded by !**/*.png
  • assets/iconpack_mode_new_3.png is excluded by !**/*.png
  • assets/imagevector_previewer.png is excluded by !**/*.png
  • assets/imagevector_previewer_autocomplete.png is excluded by !**/*.png
  • assets/imagevector_previewer_gutter.png is excluded by !**/*.png
  • assets/imagevector_previewer_project_view.png is excluded by !**/*.png
  • assets/simple_mode_1.png is excluded by !**/*.png
  • assets/simple_mode_2.png is excluded by !**/*.png
  • assets/simple_mode_3.png is excluded by !**/*.png
📒 Files selected for processing (1)
  • README.md

Comment thread README.md
@egorikftp egorikftp merged commit 0997dcb into main Jul 2, 2026
4 checks passed
@egorikftp egorikftp deleted the task/docs branch July 2, 2026 18:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Documentation] Cover latest changes in readme

1 participant