Skip to content

[TEC-438] Convert glossary terms into tooltips#2536

Merged
abhijna merged 15 commits intomainfrom
abhijna/tec-438-glossary
Apr 15, 2026
Merged

[TEC-438] Convert glossary terms into tooltips#2536
abhijna merged 15 commits intomainfrom
abhijna/tec-438-glossary

Conversation

@abhijna
Copy link
Copy Markdown
Collaborator

@abhijna abhijna commented Mar 26, 2026

Summary:

  • Added the Remark auto‑glossary plugin for Docusaurus
  • moved all glossary definitions into a YAML file
  • converted glossary links across docs to tooltip syntax
  • added a link to the glossary page inside the tooltip

Preview

Screenshot 2026-04-01 at 12 19 57 PM

To do:

  • A technical writer reviews the content or PR

@abhijna abhijna self-assigned this Mar 26, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 26, 2026

Deploy Preview for semgrep-docs-prod ready!

Name Link
🔨 Latest commit c5b300f
🔍 Latest deploy log https://app.netlify.com/projects/semgrep-docs-prod/deploys/69dea9086801d00009a5b026
😎 Deploy Preview https://deploy-preview-2536--semgrep-docs-prod.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 project configuration.

Comment thread package-lock.json
Comment thread yarn.lock Outdated
Comment thread package-lock.json
@abhijna abhijna requested a review from khorne3 March 30, 2026 17:51
@khorne3
Copy link
Copy Markdown
Collaborator

khorne3 commented Mar 31, 2026

@abhijna It doesn't appear that the tool tips are working in the preview? I see the link, and I get the little question mark cursor when I hover over it, but I don't get the tool tip or anything else

@abhijna
Copy link
Copy Markdown
Collaborator Author

abhijna commented Apr 1, 2026

@khorne3, fixed it! 🤞🏾

Copy link
Copy Markdown
Collaborator

@khorne3 khorne3 left a comment

Choose a reason for hiding this comment

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

LGTM!

Comment thread docs/glossary.yaml
Comment thread package-lock.json
Comment thread package-lock.json
@abhijna abhijna merged commit 495ac9d into main Apr 15, 2026
8 checks passed
@abhijna abhijna deleted the abhijna/tec-438-glossary branch April 15, 2026 16:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants