search

chaincodelabs / onboarding-to-bitcoin-core

The missing onboarding guide to Bitcoin Core
https://bitcoincore.academy
91 stars 37 forks source link

Glossary of Terms and Tooltip on abbreviations #50

Open adam2k opened 1 year ago

adam2k commented 1 year ago

This is a feature request split into two parts:

  1. Add a glossary of the abbreviations used throughout the document
  2. As a follow up, add tooltips to enable mouse over interactions that quickly display the full expansion of the abbreviations (or something similar)
adam2k commented 1 year ago

I started my own personal glossary of these terms, so I'm willing to help out with this.

willcl-ark commented 1 year ago

I think this could be pretty useful for new contributors and would be interested to see a draft PR with the terms in!

My initial thoughts would be to have the glossary as it's own file (glossary.adoc) where items are in a description list format.

Then create a link to it in index.adoc with an include as with the other sections..

Regarding the second point, I agree this would be nice, but know of no way to implement this in the current asciidoc format, without using some wizardry which I do not have the capabilites for! (I think it would have to be done with a custom inline macro, but not sure even this would work as I don't know how to link to a specific description list item...)

adam2k commented 1 year ago

Thanks @willcl-ark. The second part is a nice to have, but I can certainly open up a PR for a new glossary.adoc and then we can take it from there.

I dug into the asciidoc format docs and I agree, I can't find an easy way to do this at the moment either.

willcl-ark commented 1 year ago

Merged a first draft.

I'd like to keep this open as I think a few of the terms could do with revising, and a few new terms be added :)