Skip to content

Fix glossary builder #2336

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

Merged
merged 11 commits into from
Jun 10, 2025
Merged

Fix glossary builder #2336

merged 11 commits into from
Jun 10, 2025

Conversation

anegg0
Copy link
Contributor

@anegg0 anegg0 commented May 16, 2025

This PR does a few things:

  • Renames the CSS class tied to the glossary builder
  • Removes the Notion glossary builder
  • Regenerates the glossary using the above changes

Copy link

vercel bot commented May 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
arbitrum-docs ✅ Ready (Inspect) Visit Preview Jun 10, 2025 9:39pm

Copy link
Contributor

@douglance douglance Jun 5, 2025

Choose a reason for hiding this comment

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

if we remove the generation function that uses this, do we still need it?

looks like it's still used for some tooltips via Tippy in the quicklooks, though that means we have to maintain data in two places, right?

Copy link
Contributor

Choose a reason for hiding this comment

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

if we still want to use Tippy tooltips, it might be possible to have a naming convention for a glossary folder that has a bunch of .mdx files that we render in the tooltips based on the name of the file. I'd have to look a little closer at it.

Copy link
Contributor

Choose a reason for hiding this comment

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

We wouldn't need the Notion doc anymore; However you raise a great point - if this impacts Tippy tooltips, we would need to workaround that. I was not aware of an impact between the two.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We still use it, and it is still generated by website/src/scripts/build-glossary.ts. Do you think it answers your question, @douglance?

Copy link
Contributor

Choose a reason for hiding this comment

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

ahhh we had two similar scripts. my mistake. ty sir!

@anegg0 anegg0 merged commit 5794d09 into master Jun 10, 2025
5 checks passed
@anegg0 anegg0 deleted the fix-glossary-builder branch June 10, 2025 21:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants