♻️ Migrate to Reference Style Links about electionguard HOT 5 CLOSED

@keithrfung fair enough, that makes sense! I'll go ahead and implement the change with words, then publish the PR :)

from electionguard.

Hi @keithrfung ! I was thinking of picking up this issue. I had a couple of clarifying questions.

When you say "Use easy to understand naming", do you mean giving the links useful labels, rather than "1","2","3" as in footnote style?
Also, could you clarify what you mean by "hook up all existing links"? I take that to mean migrating any current inline links to the reference style.
Should this change apply to all .md files across the repo?

from electionguard.

I feel that giving all the links English-language labels can be time-consuming and possibly opinionated, while numbering (e.g., 1,2,3 in order of appearance) is straightforward and systematic, but curious to hear your thoughts.

from electionguard.

@keithrfung I created a PR for updating just the README. I can expand it to include all the other .md files in the repo if the format is satisfactory, or I can raise another PR for that 😀

from electionguard.

@sabaimran I commented on the PR instead of here, but I was leaning towards words instead of numbers because there are other features such as footnotes that encourage the use of numbers like so ^1 which could create confusion.

from electionguard.