Skip to content

doc: added png-to-svg-conversion-guide and updated project logos in directory - #73

Merged
Zahnentferner merged 2 commits into
AOSSIE-Org:mainfrom
reach2saksham:doc/svg-guide
Aug 12, 2026
Merged

doc: added png-to-svg-conversion-guide and updated project logos in directory#73
Zahnentferner merged 2 commits into
AOSSIE-Org:mainfrom
reach2saksham:doc/svg-guide

Conversation

@reach2saksham

@reach2saksham reach2saksham commented Aug 12, 2026

Copy link
Copy Markdown
Member

📌 Summary

Adds a comprehensive guide at Guides/PNG-to-SVG-Conversion-Guide.md providing clear workflows, best practices, and software steps for converting raster PNG logos into optimized SVGs and designing vector-first brand assets. Added the recently collected SVGs for fellow contributors into the repo.

🔗 Related Updates

  • Added reference link under Guides in README.md.
  • Added asset export callout link in Brand.md.

Additional Notes:

AI Usage Disclosure:

We encourage contributors to use AI tools responsibly when creating Pull Requests. While AI can be a valuable aid, it is essential to ensure that your contributions meet the task requirements, build successfully, include relevant tests, and pass all linters. Submissions that do not meet these standards may be closed without warning to maintain the quality and integrity of the project. Please take the time to understand the changes you are proposing and their impact. AI slop is strongly discouraged and may lead to banning and blocking. Do not spam our repos with AI slop.

Check one of the checkboxes below:

  • This PR does not contain AI-generated code at all.
  • This PR contains AI-generated code. I have read the AI Usage Policy and this PR complies with this policy. I have tested the code locally and I am responsible for it.

I have used the following AI models and tools: TODO

Checklist

  • My PR addresses a single issue, fixes a single bug or makes a single improvement.
  • My code follows the project's code style and conventions
  • If applicable, I have made corresponding changes or additions to the documentation
  • If applicable, I have made corresponding changes or additions to tests
  • My changes generate no new warnings or errors
  • I have joined the Discord server and I will share a link to this PR with the project maintainers there
  • I have read the Contribution Guidelines
  • Once I submit my PR, CodeRabbit AI will automatically review it and I will address CodeRabbit's comments.
  • I have filled this PR template completely and carefully, and I understand that my PR may be closed without review otherwise.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive guide for converting PNG images to SVG, including tools, workflows, troubleshooting, and vector design recommendations.
    • Updated branding guidance with a link to the new PNG-to-SVG and vector guidelines.
    • Improved the README’s Guides section with links to local AI setup and logo conversion documentation.

@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@reach2saksham, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 42 minutes

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 66634b10-d90a-4835-ad41-9ff5a556412a

📥 Commits

Reviewing files that changed from the base of the PR and between 19b35db and c4a85c3.

📒 Files selected for processing (2)
  • Brand.md
  • Guides/PNG-to-SVG-Conversion-Guide.md
📝 Walkthrough

Walkthrough

The pull request adds a comprehensive PNG-to-SVG conversion and vector-design guide. It links the guide from Brand.md and adds it to the README guide index.

Changes

PNG-to-SVG documentation

Layer / File(s) Summary
Add conversion and vector-design guidance
Guides/PNG-to-SVG-Conversion-Guide.md
Adds conversion workflows, tool instructions, vector authoring rules, PNG preparation requirements, decision guidance, and branding recommendations.
Update documentation links
Brand.md, README.md
Replaces the specific Figma export instruction with a link to the new guide. Adds the guide to the README Guides section alongside the Local AI Setup guide.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested labels: documentation, enhancement

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change, adding the PNG-to-SVG conversion guide, and references the accompanying project logo updates.
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.

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.

@reach2saksham reach2saksham self-assigned this Aug 12, 2026
@reach2saksham reach2saksham added documentation Improvements or additions to documentation enhancement New feature or request labels Aug 12, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 8

🧹 Nitpick comments (1)
Guides/PNG-to-SVG-Conversion-Guide.md (1)

40-40: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Add language identifiers to the diagram fences.

markdownlint reports MD040 for all six fences. Add text after each opening fence.

Also applies to: 99-99, 127-127, 175-175, 204-204, 231-231

🤖 Prompt for 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.

In `@Guides/PNG-to-SVG-Conversion-Guide.md` at line 40, Add the text language
identifier to every opening diagram code fence in
PNG-to-SVG-Conversion-Guide.md, including the six locations referenced by the
review, so each fenced block satisfies markdownlint MD040.

Source: Linters/SAST tools

🤖 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 `@Brand.md`:
- Around line 48-50: Update the logo export instructions around the PNG-to-SVG
conversion tip to include the direct Figma workflow: after selecting the
component or frame, add an SVG export configuration and click Export. Retain the
existing PNG-to-SVG conversion guide as supplementary guidance.

In `@Guides/PNG-to-SVG-Conversion-Guide.md`:
- Line 216: Update the “Export at High Resolution” guidance to retain the
minimum 2000 × 2000 pixel requirement while describing 300 DPI solely as print
metadata; do not imply that DPI increases PNG tracing detail.
- Line 125: Correct the contributor-facing wording in the guide: change
“proficieny” to “proficiency,” “dimesnions” to “dimensions,” and “Frame related”
to “Frame-related.” Simplify the sentence around the Figma and Pen tool guidance
for clearer readability while preserving its meaning.
- Line 14: Update the Table of Contents entry for “Quick Decision Tree & Summary
Cheat Sheet” to use the correct section-7 fragment,
`#7-quick-decision-tree--summary-cheat-sheet`, instead of the current `#8` fragment.
- Line 188: Update the “Pixel Grid Alignment” guidance to state that enabling
Snap to Pixel Grid can reduce fractional SVG coordinates rather than prevent
them. Add an instruction to inspect the exported SVG for remaining fractional
values after curves, boolean operations, transforms, or export.
- Line 100: Update the PNG-to-SVG workflow diagram to include selecting SVG
(svg) in the Export As format menu, confirming the SVG options, and saving the
resulting .svg file after the export step.
- Line 196: Update the “Clean Layer Hierarchy” guidance to distinguish
layer-name conventions from guaranteed SVG IDs. Instruct users relying on IDs
such as project_logo to enable Figma’s “Include id attribute” or Illustrator’s
“Object IDs: Layer Names,” configure SVGO to preserve IDs, and verify the final
SVG; otherwise describe the names only as a convention.
- Line 182: Update the stroke-conversion guidance around “Outline all Strokes to
filled paths” to limit outlining to cases where the target renderer or
production workflow requires fixed filled geometry. Instruct readers to preserve
editable strokes when supported, and recommend
vector-effect="non-scaling-stroke" for responsive SVGs needing constant stroke
width; remove the claim that normal strokes inherently distort when resized.

---

Nitpick comments:
In `@Guides/PNG-to-SVG-Conversion-Guide.md`:
- Line 40: Add the text language identifier to every opening diagram code fence
in PNG-to-SVG-Conversion-Guide.md, including the six locations referenced by the
review, so each fenced block satisfies markdownlint MD040.
🪄 Autofix

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: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 736354d2-264b-43dd-8cb0-36854bd927e0

📥 Commits

Reviewing files that changed from the base of the PR and between 845659f and 19b35db.

⛔ Files ignored due to path filters (37)
  • Project Icons/PNGs/MoveYourBody_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/aossie_light_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/aossie_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/aossie_secondary_dark_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/aossie_secondary_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/carbonTracker_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/chainvoice_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/dit_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/djed_alliance_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/ellena_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/fate_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/minichain_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/ogh_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/rein_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/stability_nexus_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/stablepay_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/tectonic_logo.png is excluded by !**/*.png
  • Project Icons/PNGs/thrubox_logo.png is excluded by !**/*.png
  • Project Icons/SVGs/MoveYourBody_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/aossie_light_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/aossie_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/aossie_secondary_dark_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/aossie_secondary_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/carbonTracker_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/chainvoice_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/dit_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/djed_alliance_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/ellena_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/fate_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/minichain_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/ogh_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/pictopy_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/rein_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/resonate_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/stability_nexus_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/stablepay_logo.svg is excluded by !**/*.svg
  • Project Icons/SVGs/thrubox_logo.svg is excluded by !**/*.svg
📒 Files selected for processing (3)
  • Brand.md
  • Guides/PNG-to-SVG-Conversion-Guide.md
  • README.md

Comment thread Brand.md
Comment thread Guides/PNG-to-SVG-Conversion-Guide.md Outdated
Comment thread Guides/PNG-to-SVG-Conversion-Guide.md Outdated
Comment thread Guides/PNG-to-SVG-Conversion-Guide.md Outdated
Comment thread Guides/PNG-to-SVG-Conversion-Guide.md Outdated
Comment thread Guides/PNG-to-SVG-Conversion-Guide.md Outdated
Comment thread Guides/PNG-to-SVG-Conversion-Guide.md Outdated
Comment thread Guides/PNG-to-SVG-Conversion-Guide.md Outdated
@Zahnentferner
Zahnentferner merged commit 648e45b into AOSSIE-Org:main Aug 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants