devportal icon indicating copy to clipboard operation
devportal copied to clipboard

Duplicate Glossary Items

Open inertia186 opened this issue 7 years ago • 2 comments

We have a few small issues with duplicates in glossary items. One, is an exact duplicate as mentioned by a community member in pull #88. But also, there are less obvious duplicates, so here's all of them:

  • steem as "Steem" and "STEEM"
  • node straight up duplicate
  • transaction as listed in Chain Basics and Transactions sections

As we expand the glossary, we need a strategy for dealing with these kinds of duplicates. Obviously, if it's truly redundant (like node), don't do it.

But The "Steem" vs "STEEM" is warranted. We do make a distinction between them. Unfortunately, the way DOM IDs are created in the document, they both become id="steem" so anchors get messed up.

Then we have logical reasons to list a definition twice, as in transaction. A transaction has a basic meaning as well as a specific meaning in the Glossary.

We could just add parentheticals to items that collide. E.g.:

  • Steem
  • STEEM (currency)
  • Transaction (Basic)
  • Transaction

AC

  • [x] Should DOM ID be a consideration in the terms?
  • [x] If so, should we add parentheticals to duplicate items?
  • [x] Roll up conclusion in this issue with the title Result

inertia186 avatar Apr 06 '18 15:04 inertia186

Result: DOM IDs will be handled with disambiguous key if needed, no parentheticals.

inertia186 avatar May 14 '18 17:05 inertia186

To find DOM ID collision (and many other issues):

bundle exec rake test:proof

inertia186 avatar Sep 04 '19 21:09 inertia186