question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

📝. Document Key Generation Section of 0.95.0 Specification in Markdown

See original GitHub issue

Is there an existing issue for this?

  • 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/

Issue Analytics

  • State:open
  • Created 2 years ago
  • Comments:5 (1 by maintainers)

github_iconTop GitHub Comments

1reaction
Sumithra-Sudhakarcommented, Oct 12, 2021

Can I give it a try ? @keithrfung

0reactions
Sumithra-Sudhakarcommented, Oct 15, 2021

Okay, I have started working on it!

Read more comments on GitHub >

github_iconTop Results From Across the Web

📝. Document Acknowledge Section of 0.95.0 Specification in ...
Document Overview Section of 0.95.0 Specification in Markdown for easy ... Components) --- Baseline Parameters --- Key Generation --- Ballot ...
Read more >
Extended Syntax - Markdown Guide
Overview. The basic syntax outlined in the original Markdown design document added many of the elements needed on a day-to-day basis, but it...
Read more >
3.7 Markdown document | R Markdown: The Definitive Guide
The first official book authored by the core R Markdown developers that provides a comprehensive and accurate reference to the R Markdown ecosystem....
Read more >
Introductory Guide to Markdown for Documentation Writers
This section helps you understand what's going on under the hood, in between formatting your Markdown files and the final rendered output ...
Read more >
RFC 7763: The text/markdown Media Type
Status of This Memo This document is not an Internet Standards Track specification; it is published for informational purposes. This document is a...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found