Comments (5)
@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.
Related Issues (20)
- ✨ 📆 Add video links to agenda for sharing
- 🐞 Specification 1.1 for extended crypto_hash does not match implementation.
- 🐞 Fix Schema for votes_allowed and number_elected HOT 2
- ✨ Schema and example election record with use of range Chaum-Pedersen proofs and no placeholder selections are needed
- Push updated spec to website HOT 1
- ✨ Typo in docs/index.md HOT 1
- 🐞 Update ElectionGuard spec download links and badges to 1.1
- ✨ Create a definitive sample manifest to avoid confusion and illustrate all important formatting requirements HOT 2
- ✨ Update specification links to point to 1.1
- ✨ Update site content architecture and various links
- ✨ interim roadmap update
- ✨ Update ElectionGuard election record structure to handle large elections
- 🐞 Manifest Schema - references to ballot_name
- ✨ Publish 2.0 spec
- ✨ Schema and Sample Update
- ✨ Update spoiled language to reflect current naming HOT 1
- ✨ Election Record and Schema for Challenged Ballots
- 🐞 Schema Cleanup
- 🐞 Architecture Docs are Stale
- ✨ College Park election writeup and archticture update
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from electionguard.