Election-Tech-Initiative / Election-Tech-Initiative/electionguard

📝. Document Key Generation Section of 0.95.0 Specification in Markdown

Open
#135 6 comments 0 reactions 1 assignee Claimed by @colleenirt View on GitHub
documentation question triage
Dominant language
Python
Stars
872
Forks
131
PR merge metrics
No merged PRs in 30d

Description

### Is there an existing issue for this?

- [X] I have searched the existing issues

### Suggestion

Document **Key Generation** Section of 0.95.0 Specification in Markdown for easy consumption on the web. This should be as close as possible to a 1 to 1 translation.

### Possible Implementation

Using the 0.95.0 Specification (https://github.com/microsoft/electionguard/releases/download/v0.95.0/ElectionGuard_Specification_v0_95_0.pdf) provided, create a markdown documentation page for the specific section mentioned. The page should be created within the `spec/web` folder

#### Headings
There should be only one H1 heading which will presented as the title of the page.
Any other headings should be H2 or smaller according to their section.

#### Equations
Equations should use the built-in feature.
https://squidfunk.github.io/mkdocs-material/reference/mathjax/

#### Tables
Tables should use the built-in feature.
https://squidfunk.github.io/mkdocs-material/reference/data-tables/

#### Images
We want to keep the images matching the existing style of the site. These should not be copy and pasted from the document, but created preferably. If there is no other option, screenshots from the document will be accepted.

The images may be created as svg's using https://themeisle.com/illustrations/ and/or https://undraw.co/ with the color (#80CBC4) (Preferred)

OR

By using mermaid documentation:
https://mermaid-js.github.io/mermaid/#/
https://squidfunk.github.io/mkdocs-material/reference/diagrams/

#### Green and Blue Boxes

All blue boxes should be Note admonitions.
All green boxes should be Important admonitions
https://squidfunk.github.io/mkdocs-material/reference/admonitions

#### Navigation

This is the overall navigation
```
--- Overview <-- Overview
--- Structure <-- ElectionGuard Structure
--- Components <-- ElectionGuard Components (2nd ElectionGuard Components)
--- Baseline Parameters
--- Key Generation
--- Ballot Encryption
--- Ballot Aggregation
--- Verifiable Decryption
--- Election Record <-- The Election Record
--- Verifier Construction
------ Parameter Validation
------ Guardian Public-Key Validation
------ ...
--- Applications <-- Applications to end-end verifiability and risk limited audits
--- Acknowledgements
```

This specific page should be linked under web in the `mkdocs.yml`.
An example is https://www.electionguard.vote/spec/web/1_Overview/

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.