Skip to content

feat: Add glossary links to documentation#78

Open
solzlivinglife wants to merge 6 commits intorobotframework:glossary-proposalfrom
solzlivinglife:glossary-proposal
Open

feat: Add glossary links to documentation#78
solzlivinglife wants to merge 6 commits intorobotframework:glossary-proposalfrom
solzlivinglife:glossary-proposal

Conversation

@solzlivinglife
Copy link

  - Automatically linked 80+ glossary terms
  - Links use relative paths for local dev compatibility
  - Covers argument types, variables, control structures, core concepts
  - Tested locally and in production build
  - All links verified working correctly

solomon.legodi added 2 commits February 2, 2026 15:10
      - Automatically linked 80+ glossary terms
      - Links use relative paths for local dev compatibility
      - Covers argument types, variables, control structures, core concepts
      - Tested locally and in production build
      - All links verified working correctly
@GerwinLaagland
Copy link
Collaborator

Hello, hello. Thanks for your work! I took a look with @Snooz82 at the reason why the github actions for this PR is failing.

It turns out that the learning_objectives.md document is used to generate numbers. So it's better to not link any terms when you're working with the LO's themselves.

Example to avoid
image

Can you remove those? The actions should then work.

solomon.legodi added 4 commits February 26, 2026 16:27
This file is used for auto-generating LO numbers and should not contain glossary links.
Downloaded directly from main branch to ensure no glossary links remain.
@GerwinLaagland
Copy link
Collaborator

GerwinLaagland commented Feb 26, 2026

Hi @solzlivinglife ,

I’d like to correct my earlier comment regarding the GitHub Actions failure — I was mistaken about learning_objectives.md being used to generate numbering. I have misunderstood the explanation that was given to me. Apologies for this, when next @Snooz82 speaks, I should pay better attention. 😰

After reviewing the script responsible for this more carefully, I see that numbering is derived directly from the chapter markdown files under website/docs/chapter-*, and learning_objectives.md is generated from those files.

I'm terribly sorry for the confusion and any extra work this may have caused.

The solution instead is to avoid adding links inside :::Kx[LO-x.x.x] :::-blocks. The LO content is extracted verbatim and reused in generated artifacts (learning_objectives.md and LOs.csv). Including links inside these blocks leads to formatting changes or auto-modifications during the generation step, causes CI to fail if the generated files are altered.

Thanks for your patience — and thanks again for the work on this PR.

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