iota-wiki icon indicating copy to clipboard operation
iota-wiki copied to clipboard

Feat - JSON Glossary

Open lucas-tortora opened this issue 2 years ago • 5 comments

Description of change

  • Added JSON Based glossary
  • Added react tooltip package
  • Added GlossaryTooltip component

Type of change

  • Enhancement (a non-breaking change which adds functionality)

How the change has been tested

Wiki was built locally.

Change checklist

  • [x] I have followed the contribution guidelines for this project
  • [x] I have performed a self-review of my own code
  • [x] I have commented my code, particularly in hard-to-understand areas
  • [x] I have tested the wiki locally and tested that all external links work

lucas-tortora avatar Jul 29 '22 11:07 lucas-tortora

@Dr-Electron, I think I sorted out the nuisances we discussed last week.
@jlvandenhout, if you have some time, it'd be great to get your opinion on this.

lucas-tortora avatar Jul 29 '22 11:07 lucas-tortora

@lucas-tortora can I ask you to solve the merge conflicts?

Dr-Electron avatar Aug 14 '22 22:08 Dr-Electron

Nice. Now the build fails 😅

Dr-Electron avatar Aug 16 '22 21:08 Dr-Electron

Just to be sure, we still need a way to add these glossary components to the actual terms in the text during build right? If we want to add them manually, that requires all docs to become MDX, which I'm not sure of if we want that.

jlvandenhout avatar Aug 20 '22 22:08 jlvandenhout

Just to be sure, we still need a way to add these glossary components to the actual terms in the text during build right? If we want to add them manually, that requires all docs to become MDX, which I'm not sure of if we want that.

I think that would be ideal, however, I'm not sure how to actually do that. :(

lucas-tortora avatar Aug 22 '22 12:08 lucas-tortora

Wasn't the plan to write a remark plugin for that?

Dr-Electron avatar Sep 01 '22 08:09 Dr-Electron

Wasn't the plan to write a remark plugin for that?

It was, but I have no idea where to start to be honest.

lucas-tortora avatar Sep 01 '22 11:09 lucas-tortora

Haha, fair point. Then let's try to do that. I will ask Josh what the best approach for this could be

Dr-Electron avatar Sep 01 '22 13:09 Dr-Electron