-
Notifications
You must be signed in to change notification settings - Fork 22
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(icon): add new icon system ADR #688
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey !
Really great work 🚀 , you managed to deliver a synthetic explanation for tricky subject, it was very interesting to read 👍
Since you managed to keep your part fairly short, I think we could keep a single ADR with the accessibility part inside, as it is right now but let's see what others think 👍 (one way or another, I'm ok with it 😉
I added suggestions, mainly rewording (which is quite subjective as always so really it's up to you in most cases 😉).
About the headings in the "The problem" section, I wonder if we could use headings that describe the problems a little bit more like:
"As static assets with no backing icon library" => "(Lack of) Standardization and optimization"
"As image tags" => "(Lack of) Customization"
"And more" => "(Lack of) Compatibility"
Not sure the "Lack of" is necessary because we're in "The problem" (might need to become "The problems" now that I think about it).
WDYT?
Also, I remember you explained why you went for inline <svg>
elements instead of sprites (not sure this is the right terminology, sorry if not) during a meeting.
Should we say more about this subject in this ADR? I thought it was an interesting subject and it could be great to write down the downsides that made us choose inline <svg>
instead. (I say that but I realise it's not an easy subject ahah)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Impressive work @roberttran-cc 👏 !!!
I'm not sure how to write it but in the context or the problem section, we could mention that a few shortcuts were made at the beginning while it was a one-person project. Defining a robust icon strategy was one of them. Now that we have a need we can and need to address this.
(Aside note, E2E tests is also one of those shortcuts)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome work. Well done.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, gg that's impressive 👏 🤯
c132694
to
0128742
Compare
The ADR is long but I don't see it as a problem. I think I prefer to have the a11y part along with the rest. So no split for me.
|
0128742
to
aeb1d33
Compare
Fixes #683.
Looking forward your feedback! 😇
I tried to avoid adding too much details, to keep the document readable, but some parts may be lacking. 😵
Question 1
I decided to put @florian-sanders-cc's a11y part inside this ADR but, after some thoughts, should we do like the toaster's ADRs and split the content? I'm not sure it is relevant in this case, WDYT?
Question 2 (from @florian-sanders-cc)
Some headings proposals, WDYT bis? Details in his answer.
TO DO after review and before merging :