Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add Icons rendering section #2217

Merged
merged 1 commit into from
Feb 23, 2024

Conversation

julien-deramond
Copy link
Member

@julien-deramond julien-deramond commented Sep 5, 2023

Description

This PR adds a section explaining how icons are built/rendered within a square and with a safe zone.

Motivation & Context

In projects, we are often wondering whether this safe zone is normal or not. Some designers in the projects remove them, some keep them. The purpose here is to fix this rule in our documentation.

Types of change

  • Enhancement (non-breaking change which adds functionality)

Live previews

Checklist

Contribution

Documentation

  • My change introduces changes to the documentation and/or I have updated the documentation accordingly

@julien-deramond julien-deramond added v5 docs Improvements or additions to documentation enhancement labels Sep 5, 2023
@netlify
Copy link

netlify bot commented Sep 5, 2023

Deploy Preview for boosted ready!

Name Link
🔨 Latest commit 570b92c
🔍 Latest deploy log https://app.netlify.com/sites/boosted/deploys/65d86b785087670008f6260d
😎 Deploy Preview https://deploy-preview-2217--boosted.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@julien-deramond julien-deramond marked this pull request as ready for review September 5, 2023 09:49
Copy link
Member

@hannahiss hannahiss left a comment

Choose a reason for hiding this comment

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

Maybe we could add an icon less "rounded"? Maybe tick and/or delete? The size difference would be more obvious...

Copy link
Member

@hannahiss hannahiss left a comment

Choose a reason for hiding this comment

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

I think it's great to have theses explanations... Some comments:

  • Maybe we could add an icon less "rounded"? Maybe tick and/or buy? The size difference will be more obvious...
  • Icons rendering could be a level 2 title directly after the introduction of the page regarding PR Docs: enhance doc for Solaris icons #2075
  • I would add a little bit more explanations eg:
    Icons are created in a square layout to maintain consistency. This square contains a safety zone that allows the icons to be used in different sizes and contexts and still be aligned as the designers wish. The size of the icons includes this safety zone.

@julien-deramond julien-deramond force-pushed the main-jd-add-paragraph-about-icons-rendering branch from cb21121 to d1c40d9 Compare February 23, 2024 06:03
@julien-deramond julien-deramond changed the base branch from main to main-his-solaris-icons-doc February 23, 2024 06:03
@julien-deramond
Copy link
Member Author

Thanks for your comment @hannahiss! It's been taken into account in d362d15.

Copy link
Member

@hannahiss hannahiss left a comment

Choose a reason for hiding this comment

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

there exists => there is ?
2 times ensure/ensuring => there is a designated safety zone to ensure that icons can be used in various sizes and contexts while keeping alignment as intended by the designers ?

Base automatically changed from main-his-solaris-icons-doc to main February 23, 2024 09:50
@julien-deramond julien-deramond force-pushed the main-jd-add-paragraph-about-icons-rendering branch from 5d9730f to 570b92c Compare February 23, 2024 09:55
@julien-deramond julien-deramond merged commit 118d0a4 into main Feb 23, 2024
12 checks passed
@julien-deramond julien-deramond deleted the main-jd-add-paragraph-about-icons-rendering branch February 23, 2024 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation enhancement v5
Projects
Development

Successfully merging this pull request may close these issues.

2 participants