Dynamic Glossary #72

Snooz82 · 2025-12-05T19:13:21Z

This PR implements a dynamic glossary with search and alias.
The glossary is stored in a JSON file (website/static/glossary/glossary.json), so that the glossary definition can be used by dynamic glossary tool tips in all MarkDown documents.

2025-12-06_00-21-54.mp4

I implemented the glossary terms to be hovered and a dynamic glossary.

The glossary is based on a json file.

	{
		"term": "Named-Only Argument",
		"aliasses": ["Named Argument"],
		"abbreviation": "",
		"definition": "An argument that must be provided by name (never positionally); typically defined after a \"Variable Number of Positional Arguments\" or explicitly marked with a label icon in docs, and can be mandatory or optional."
	},

the usage is like this in Markdown:

Except for "Positional-Only Arguments", which are not part of this syllabus,
all arguments that are positioned before :term[Variable Number of Positional Arguments], :term[Named-Only Arguments]{term="Named-Only Argument"}, or :term[Free Named Arguments]{term="Free Named Argument"} in the argument interface of a keyword are :term[Positional or Named Arguments]{term="Positional or Named Argument"}.

so either if the exact term is used:

:term[Variable Number of Positional Arguments]

or in case a different grammatical form is used:

:term[Named-Only Arguments]{term="Named-Only Argument"}

Signed-off-by: René <snooz@posteo.de>

github-actions · 2025-12-05T19:15:03Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2025-12-05T19:29:09Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

website/static/glossary/glossary.json

website/src/components/Glossary/GlossaryTable.tsx

website/src/components/Glossary/GlossaryTable.module.css

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-12-05T21:12:06Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Signed-off-by: René <snooz@posteo.de>

github-actions · 2025-12-05T23:24:10Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Snooz82 · 2025-12-05T23:26:31Z

2025-12-06_00-21-54.mp4

I implemented the glossary terms to be hovered and a dynamic glossary.

The glossary is based on a json file.

	{
		"term": "Named-Only Argument",
		"aliasses": ["Named Argument"],
		"abbreviation": "",
		"definition": "An argument that must be provided by name (never positionally); typically defined after a \"Variable Number of Positional Arguments\" or explicitly marked with a label icon in docs, and can be mandatory or optional."
	},

the usage is like this in Markdown:

Except for "Positional-Only Arguments", which are not part of this syllabus,
all arguments that are positioned before :term[Variable Number of Positional Arguments], :term[Named-Only Arguments]{term="Named-Only Argument"}, or :term[Free Named Arguments]{term="Free Named Argument"} in the argument interface of a keyword are :term[Positional or Named Arguments]{term="Positional or Named Argument"}.

so either if the exact term is used:

:term[Variable Number of Positional Arguments]

or in case a different grammatical form is used:

:term[Named-Only Arguments]{term="Named-Only Argument"}

Signed-off-by: René <snooz@posteo.de>

Copilot

Pull request overview

Copilot reviewed 18 out of 20 changed files in this pull request and generated 2 comments.

Files not reviewed (1)

website/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

website/static/glossary/glossary.json

website/docs/chapter-02/05_keyword_interface.md

github-actions · 2025-12-05T23:31:53Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Signed-off-by: René <snooz@posteo.de>

github-actions · 2025-12-05T23:35:32Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2025-12-05T23:36:28Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Copilot

Pull request overview

Copilot reviewed 18 out of 20 changed files in this pull request and generated 9 comments.

Files not reviewed (1)

website/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

website/src/components/Term.tsx

Copilot · 2025-12-06T00:27:40Z

website/src/components/Glossary/GlossaryTable.tsx

+          </thead>
+          <tbody>
+            {filteredEntries.map((entry) => {
+              const definitionHtml = sanitizeMarkdown(entry.definition, purify);


sanitizeMarkdown is called inside the render loop for every filtered entry on every render, which is inefficient. Consider computing the sanitized HTML once when creating the entries (in the useMemo at line 45-85) and storing it in the DisplayEntry type, or memoize this computation separately to avoid re-parsing and re-sanitizing markdown on every render.

@copilot open a new pull request to apply changes based on this feedback

website/src/components/Glossary/GlossaryTable.module.css

website/src/components/Glossary/GlossaryTable.tsx

website/docs/chapter-01/04_styles.md

Copilot · 2025-12-06T00:27:41Z

website/src/components/Term.tsx

+      {open && hasTooltip && portalReady
+        ? createPortal(
+            <div
+              role="dialog"


The dialog tooltip is missing an accessible label. Consider adding aria-label or aria-labelledby to the dialog div to improve screen reader experience. For example: aria-label={Definition of ${trigger || children}} would help screen reader users understand what the dialog contains.

Suggested change

role="dialog"

role="dialog"

aria-label={`Definition of ${trigger ?? children}`}

website/src/components/Glossary/GlossaryTable.tsx

website/src/components/Term.tsx

Signed-off-by: René <snooz@posteo.de>

hassineabd · 2025-12-06T15:28:28Z

website/static/glossary/glossary.json

I think the new glossary table have resolved most of existing problems: like definining test suite as test suite file , ( suite vs suite file vs directory ) ,,, user keyword vs library keyword vs Keywod in general

but, i see that the current version miss some of term that have been existing before ( is this intentional ) :
Settings Section
Variables Section
Test Cases Section
Tasks Section
Keywords Section
Comments Section

Also , I have identified two kewords that are not defined : Rebot & Libdoc ( ~~already added on slack glossary table~~ actually, it looks like there were existing and we just lost them after the edit )

rebot and libdoc are only mentioned a hand full of times together with the explantation. So imho no definition for those nedded.

not sure how we should define the Settings Section
Open for proposals.

Copilot · 2025-12-07T12:16:43Z

@Snooz82 I've opened a new pull request, #73, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-12-07T12:30:45Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Signed-off-by: René <snooz@posteo.de>

- [x] Revert to useMemo approach for entries and aliasToCanonicalSlug - [x] Remove unnecessary purifyRef and purifyReady state - [x] Simplify sanitization logic while maintaining security - [x] Ensure proper SSR handling - [x] Test and validate changes (TypeScript passes, dev server runs) - [x] Clean up build artifacts from repository - [x] Code review and security checks passed (CodeQL found no issues)  --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Snooz82 <41592183+Snooz82@users.noreply.github.com> Co-authored-by: René <snooz@posteo.de> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-12-07T13:18:50Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

github-actions · 2025-12-07T13:19:59Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Signed-off-by: René <snooz@posteo.de>

github-actions · 2025-12-07T13:25:20Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

github-actions · 2025-12-07T13:28:46Z

🚀 Preview deployed to https://robotframework-RFCP-syllabus-pr-72.surge.sh/robotframework-RFCP-syllabus/

Snooz82 added 2 commits December 5, 2025 20:10

implemented dynamic glossary

3c25a41

Signed-off-by: René <snooz@posteo.de>

implemented dynamic glossary

dbb34ac

Signed-off-by: René <snooz@posteo.de>

Snooz82 added this to the 1.0.2 milestone Dec 5, 2025

Snooz82 self-assigned this Dec 5, 2025

Snooz82 requested review from a team and Copilot December 5, 2025 19:13

Snooz82 added the enhancement New feature or request label Dec 5, 2025

Copilot started reviewing on behalf of Snooz82 December 5, 2025 19:13 View session

Snooz82 temporarily deployed to preview December 5, 2025 19:14 — with GitHub Actions Inactive

Snooz82 had a problem deploying to preview December 5, 2025 19:14 — with GitHub Actions Failure

Snooz82 temporarily deployed to preview December 5, 2025 19:28 — with GitHub Actions Inactive

Copilot AI reviewed Dec 5, 2025

View reviewed changes

Update website/static/glossary/glossary.json

92e5027

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Snooz82 temporarily deployed to preview December 5, 2025 21:11 — with GitHub Actions Inactive

implemented glossary tooltips

d6171b7

Signed-off-by: René <snooz@posteo.de>

Snooz82 temporarily deployed to preview December 5, 2025 23:23 — with GitHub Actions Inactive

Snooz82 requested a review from Copilot December 5, 2025 23:27

Copilot started reviewing on behalf of Snooz82 December 5, 2025 23:27 View session

implemented glossary tooltips

91c3482

Signed-off-by: René <snooz@posteo.de>

Copilot AI reviewed Dec 5, 2025

View reviewed changes

website/static/glossary/glossary.json Outdated Show resolved Hide resolved

website/docs/chapter-02/05_keyword_interface.md Outdated Show resolved Hide resolved

Snooz82 temporarily deployed to preview December 5, 2025 23:31 — with GitHub Actions Inactive

fixed typos

3349f89

Signed-off-by: René <snooz@posteo.de>

Snooz82 temporarily deployed to preview December 5, 2025 23:35 — with GitHub Actions Inactive

Snooz82 temporarily deployed to preview December 5, 2025 23:36 — with GitHub Actions Inactive

Snooz82 requested a review from Copilot December 6, 2025 00:20

Copilot started reviewing on behalf of Snooz82 December 6, 2025 00:21 View session

Copilot AI reviewed Dec 6, 2025

View reviewed changes

updated glossary terms around Arguments

9041b67

Signed-off-by: René <snooz@posteo.de>

Snooz82 had a problem deploying to preview December 6, 2025 12:35 — with GitHub Actions Failure

hassineabd reviewed Dec 6, 2025

View reviewed changes

Copilot AI mentioned this pull request Dec 7, 2025

Optimize GlossaryTable: pre-compute sanitized HTML #73

Merged

7 tasks

Apply suggestions from code review

8ebbf11

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Snooz82 temporarily deployed to preview December 7, 2025 12:30 — with GitHub Actions Inactive

improved css of glossary terms

74638ac

Signed-off-by: René <snooz@posteo.de>

Snooz82 temporarily deployed to preview December 7, 2025 13:18 — with GitHub Actions Inactive

Snooz82 temporarily deployed to preview December 7, 2025 13:19 — with GitHub Actions Inactive

improved outline in dark mode

c5ed31c

Signed-off-by: René <snooz@posteo.de>

Snooz82 temporarily deployed to preview December 7, 2025 13:25 — with GitHub Actions Inactive

Update website/src/components/Term.tsx

d648e8a

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Snooz82 deployed to preview December 7, 2025 13:28 — with GitHub Actions View deployment

	role="dialog"
	role="dialog"
	aria-label={`Definition of ${trigger ?? children}`}

Dynamic Glossary #72

Are you sure you want to change the base?

Dynamic Glossary #72

Uh oh!

Conversation

Snooz82 commented Dec 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

Snooz82 commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

github-actions bot commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Dec 6, 2025

Choose a reason for hiding this comment

Uh oh!

Snooz82 Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Dec 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

hassineabd Dec 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Snooz82 Dec 7, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025

Uh oh!

github-actions bot commented Dec 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Snooz82 commented Dec 5, 2025 •

edited

Loading

hassineabd Dec 6, 2025 •

edited

Loading