Dynamic Glossary by Snooz82 · Pull Request #72 · robotframework/robotframework-RFCP-syllabus

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/

website/static/glossary/glossary.json

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/

GerwinLaagland · 2026-03-22T14:34:49Z

Based on some of the feedback during community day, I wanted to raise two more points of interest before we merge this:

1. A Term should exist as 'a term', aliases should not have their own entry
Aliases shouldn't have a 'separate' entry in glossaries, but mentioned just in the 'main entry' they can be searched with either specific or lazy search option. This can tighten the glossary a bit more instead of riddling it with additional 'terms' that are in fact only aliases. A term should reflect the actual term, not alternates for it.

2. Describe in the description if alternate word is an Alias or Abbreviation
For clarity it's preferable to know when something is considered an 'alias' or 'abbreviation', this should be displayed in the glossary description entries rather than having only a 'green block' that could be either. We should have not both entries be the same. (As we are seeing that with for example gTAA)

3. (Optional) Allow for a 'backlink' generated solution in Glossary / linking.
A notation method to link to a 'in context' location inside the glossary, so that people can navigate from the glossary to the place (or places) where they can read more about a term inside that context. This allows for navigation (with pop-up)

We could keep the current :term[...] notation and extend it only for the special cases where we want a glossary backlink.

Examples:

:term[Variable Scope]
:term[test cases]{term="Test Case"}
:term[Variable Scope]{source="#variable-scope-explained"}
:term[test cases]{term="Test Case" source="/docs/tests#test-case-structure"}

Proposal:

Keep :term[...] as the standard glossary link syntax.
Keep {term="..."} for alias text.
Add an optional source="..." attribute for the few cases where a glossary entry should offer a “read more” backlink into the docs.
If no source is given, no backlink is created.

4. (Optional) Support for Rabbit Holes
A suggestion was made that it would be nice to do 'pop-up within pop-up' allow for easy navigation of term descriptions that might lead to other terms again. An example was set sent to me, and can be found here:
https://mystmd.org/guide#cool-myst-features

Copilot

Copilot was unable to review this pull request because the user who requested the review is ineligible. To be eligible to request a review, you need a paid Copilot license, or your organization must enable Copilot code review.

github-actions · 2026-03-26T12:01:04Z

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

GerwinLaagland

Feedback will be raised as separate issues at a later date.

github-actions · 2026-03-26T15:49:49Z

🚀 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

hassineabd reviewed Dec 6, 2025

View reviewed changes

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

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 temporarily deployed to preview December 7, 2025 13:28 — with GitHub Actions Inactive

Merge branch 'main' into glossary-proposal

1dedd49

Copilot AI review requested due to automatic review settings March 26, 2026 11:59

Copilot AI reviewed Mar 26, 2026

View reviewed changes

leeuwe temporarily deployed to preview March 26, 2026 12:00 — with GitHub Actions Inactive

leeuwe self-requested a review March 26, 2026 13:34

leeuwe approved these changes Mar 26, 2026

View reviewed changes

GerwinLaagland approved these changes Mar 26, 2026

View reviewed changes

leeuwe deployed to preview March 26, 2026 15:49 — with GitHub Actions View deployment

leeuwe merged commit 7f8d557 into main Mar 26, 2026
9 checks passed

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!

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!

GerwinLaagland commented Mar 22, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

GerwinLaagland left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Snooz82 commented Dec 5, 2025 •

edited

Loading