Figma / UI kit release notes style guide
As we iterate on release post styles, the following items from !3458 (merged) were brought up for further discussion. If there is a decision on these items, perhaps we should make a list of the rules/guidelines for reviewers to reference?
- How to handle links - when should they be bold, when not, when should they use the component styling?
@danmh suggested:
I feel most comfortable using it when linking to a ❖ ComponentName, or a PageTitle. I don't think I like it when its talking about a group of components or a frame.
For example:
- ❖ Alert is a Figma component,
✅ - Skeleton loader is actually a page, rather than a Figma component, so I think should be Skeleton loader
- dropdown types is a frame, so I think should be dropdown types
- GitLab Mono font test is 1 line of text inside a font test sticky, so I think should be GitLab Mono font test.
Additional discussion in this thread: !3458 (comment 1521794761)
- Do y'all want to keep the current groupings of content on the release posts? @jeldergl's thoughts on the current groupings:
- Addition: Something new that hasn't existed in this form (or at all) in the UI kit before.
- Enhancement: Improving something that already exists.
- Change: A refactor that can be positive, neutral, or negative.
- Fix: Something was broken and needed addressed.
- Deprecation: Something will be removed.
- Removal: Something has been removed.
Is this what we want to stick with? Or, is there a possibility to combine some of these (for example, addition and enhancement)? Additional discussion here: !3458 (comment 1521815090)