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: fix search for tokens #218

Merged
merged 2 commits into from
Mar 20, 2024
Merged

docs: fix search for tokens #218

merged 2 commits into from
Mar 20, 2024

Conversation

ninamarina
Copy link
Contributor

@ninamarina ninamarina commented Mar 20, 2024

docs: fix search for tokens

We discovered that for Android and iOS searching for tokens in figma format would not brung any results.
For example, searching for typography/body/md:

Before
image

Now
image

Obligatory GIF (super important!)

Obligatory GIF

🛠️ Type Of Change

These types will increment the version number on release:

  • Fix
  • Feature
  • Performance Improvement
  • Refactor

These types will not increment the version number, but will still deploy to documentation site on release:

  • Documentation
  • Build system
  • CI
  • Style (code style changes, not css changes)
  • Test
  • Other (chore)

📖 Jira Ticket

No Jira

Copy link

✔️ Deploy previews ready!
😎 Dialtone preview: https://dialtone.dialpad.com/deploy-previews/pr-218/

@ninamarina ninamarina marked this pull request as ready for review March 20, 2024 14:59
Copy link

✔️ Deploy previews ready!
😎 Dialtone preview: https://dialtone.dialpad.com/deploy-previews/pr-218/

Copy link
Contributor

@yorbi-dp yorbi-dp left a comment

Choose a reason for hiding this comment

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

This looks great! Thanks a bunch for the quick fix.

@iropolo
Copy link
Contributor

iropolo commented Mar 20, 2024

Okay so...

type of searches:

  1. typography body md
  2. typography/body/md
  3. typography-body-md

Before:
CSS: 1,2,3
Android: 1
IOs: 1

Now:
CSS: 1,2,3
Android: 1,2
IOs: 1,2


Seems like there is no / or - tokens in Android and IOs, but there is - tokens on CSS.
What I suggest is remove / and just let 1 and 3 method.

CSS: 1,3
Android: 1,3
IOs: 1,3

I see it more naturally. Or, add - to Andoroid and IOs too to be consistent.

But this is a design decision probably, I'm not sure why we decide to use / to separate words.

There is also a noticed lag on switching to Token page, we should investigate it to improve. Technical improvement or Design Decision by splitting into sections.

@yorbi-dp
Copy link
Contributor

But this is a design decision probably, I'm not sure why we decide to use / to separate words.

Screenshot 2024-03-20 at 12 07 49 PM

This is how Figma currently displays the style names. Hopefully, we will get an update soon to show the actual token name in the Figma UI.

@ninamarina
Copy link
Contributor Author

ninamarina commented Mar 20, 2024

There is also a noticed lag on switching to Token page, we should investigate it to improve

Yes, this is because the list is really long. The performance issue is in the render phase, so it's tricky to improve it, but we talked about if we can do some "lazy rendering" and add a loading state. I don't think pagination is possible since we have the table of contents with the anchor links.

@ninamarina ninamarina merged commit ff46724 into staging Mar 20, 2024
7 checks passed
@ninamarina ninamarina deleted the fix/tokens-search branch March 20, 2024 17:22
braddialpad pushed a commit that referenced this pull request Mar 22, 2024
# [9.24.0](dialtone/v9.23.0...dialtone/v9.24.0) (2024-03-22)

### Bug Fixes

* **Emoji:** dlt-1650 pad emoji unicode string with 0's ([#219](#219)) ([1eb4906](1eb4906))
* warn console error cleanup ([#221](#221)) ([65bb319](65bb319))

### Documentation

* add tokens keywords ([#220](#220)) ([20125f4](20125f4))
* fix search for tokens ([#218](#218)) ([ff46724](ff46724))

### Features

* added new headset icon and update listed icons ([#224](#224)) ([c1373ec](c1373ec))
* adding new blog for Types update ([#222](#222)) ([73b40f3](73b40f3))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants