robotframework / robotframework/robotframework-RFCP-syllabus

Support for Rabbit Holes in Glossary Pop-up

Open
#86 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

prio:low
Dominant language
TypeScript
Stars
20
Forks
20
PR merge metrics
No merged PRs in 30d

Description

A suggestion was made during community day at RoboCon that it would be nice to do 'pop-up within pop-up' when necessary to allow for easy navigation of term descriptions that might lead to other terms again. An example was sent to me, and can be found here:
https://mystmd.org/guide#cool-myst-features

This only makes sense if we have terms referring to other terms in their definitions however. I'm not sure if that is the case right now. So for completeness just mentioning it here as a possible feature.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the glossary pop-up implementation and checking whether current term definitions can refer to other terms. Review the linked mystmd example for the intended navigation pattern. Done would mean supporting nested term pop-ups when definitions link to other glossary terms, if such references exist.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.