Skip to content

Commit

Permalink
♻️ Reorganize Specification (#201)
Browse files Browse the repository at this point in the history
Reorganize the specification to focus on the official pdf specifications instead of the web version to avoid confusion while the web version is under construction. 

- Added downloads that directly go to pdfs
- Fix any links to the specifications 
- move the web spec to only include one version
- simplify the navigation
  • Loading branch information
keithrfung authored Jan 25, 2022
1 parent 882b44f commit 9395694
Show file tree
Hide file tree
Showing 16 changed files with 51 additions and 46 deletions.
4 changes: 2 additions & 2 deletions docs/develop/Repositories.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The ElectionGuard Specification repository addresses the mathematical and concep

The ElectionGuard site is also built from this repository using mkdocs. This can be a friendly place to start out for new developers trying to get started.

[:fontawesome-brands-github: ElectionGuard Specification][election-guard-spec-overview]
[:fontawesome-regular-file: Specification][election-guard-spec-overview] | [:fontawesome-brands-github: Source][election-guard-specification]

## <div style="display: flex; align-items: center;">ElectionGuard Python<span style="display: flex; align-items: center; margin-left: 16px"> ![Python][python-logo] <span></div>

Expand Down Expand Up @@ -72,7 +72,7 @@ This UI application features several TypeScript packages as a monorepo, a versio
[election-guard-python-documentation]: https://microsoft.github.io/electionguard-python/ "Election Guard Python documentation"
[election-guard-cpp-source]: https://github.com/microsoft/electionguard-cpp "Election Guard C++ source code"

[election-guard-spec-overview]: ../spec/0.95.0/1_Overview.md "Election Guard Specification Overview"
[election-guard-spec-overview]: ../../spec "ElectionGuard Specification"
[election-guard-verifiability]: ../concepts/Verifiability.md "Election Guard Verifiability"
[election-guard-post-election-audit]: ../Glossary/#post-election-audit "Election Guard Post-Election Audit"

Expand Down
2 changes: 1 addition & 1 deletion docs/overview/Glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ A zero-knowledge proof is a method by which one party (the prover) can prove to
[^2]: [Zero-Knowledge Proof from Wikipedia][zero-knowledge-proof]

<!-- Links -->
[Specification]: ../../spec/0.95.0/1_Overview
[Specification]: ../../spec
[Repositories]: ../../develop/Repositories
[nist-data-format]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.1500-100r2.pdf "NIST Election Results Common Data Format Specification"
[civics-data-format]: https://developers.google.com/elections-data/reference "Civics Common Standard Data Specification"
Expand Down
8 changes: 0 additions & 8 deletions docs/spec/0.85.0/1_Overview.md

This file was deleted.

7 changes: 0 additions & 7 deletions docs/spec/1.0.0/1_Overview.md

This file was deleted.

31 changes: 31 additions & 0 deletions docs/spec/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# ElectionGuard Official Specifications

The official versions of the ElectionGuard Specifications are listed below and stand as the primary source of reference when discussing the [ElectionGuard Specification]. Each version includes a [badge] that can be used to quickly display which versions are supported or used by products following the specification.


Version | Specification | Recommended | Badge
:------ |:-----------------------------------------------|:----------------:| :-----------
1.0.0 | _Unreleased_ | | ![Version 1.0.0][yellow-badge-1.0.0]
0.95.0 | [:material-download: Download][spec-0.95.0] | :material-check: | ![Version 0.95.0][green-badge-0.95.0]
0.85.0 | [:material-download: Download][spec-0.85.0] | | ![Version 0.85.0][green-badge-0.85.0]

!!! warning "ElectionGuard Web Specification"
The [web version] is being constructed by the open source community for the convenience of web viewing. However, it is incomplete at this time and should not be used for reference purposes. If you need a complete reference, refer to the official specifications.

<!-- Links -->
[ElectionGuard Specification]: ../overview/Glossary/#electionguard-specification
[badge]: ../develop/Badges/
[web version]: ./web/1_Overview.md

[yellow-badge-1.0.0]: https://img.shields.io/badge/Version-v1.0.0-yellow

[green-badge-0.95.0]: https://img.shields.io/badge/Version-v0.95.0-green
[spec-0.95.0]: https://github.com/microsoft/electionguard/releases/download/v0.95.0/ElectionGuard_Specification_v0_95_0.pdf "Election Guard Specification 0.95.0"

[green-badge-0.85.0]: https://img.shields.io/badge/Version-v0.85.0-green
[spec-0.85.0]: https://github.com/microsoft/electionguard/releases/download/v0.85.0/ElectionGuard_Specification_V0_85_0.pdf "Election Guard Specification 0.85.0"





File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# ElectionGuard Specification ![Version 0.95.0][green-badge-0.95.0]
# ElectionGuard Web Specification ![Version 0.95.0][green-badge-0.95.0]

!!! info "Download Specification"
Web version is under construction at this time. [Download full specification here][spec-0.95.0].
!!! warning "Incomplete"
The web version is being constructed by the open source community for the convenience of web viewing. However, it is incomplete at this time and should not be used for reference purposes. If you need a complete reference, refer to the [official specifications].

## Overview

Expand Down Expand Up @@ -29,4 +29,5 @@ This specification can be used by expert reviewers to evaluate the details of th
<!-- Links -->

[green-badge-0.95.0]: https://img.shields.io/badge/Version-v0.95.0-green
[spec-0.95.0]: https://github.com/microsoft/electionguard/releases/tag/v0.95.0 "Election Guard Specification"
[spec-0.95.0]: https://github.com/microsoft/electionguard/releases/download/v0.95.0/ElectionGuard_Specification_v0_95_0.pdf "Election Guard Specification 0.95.0"
[official specifications]: ../../
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/use_cases/Precinct_Scan.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,6 @@ A dehydrated ballot **_must_** provide the following data to be properly _rehydr
[ballot-manifest]: https://www.electionguard.vote/guide/Election_Manifest/
[ballot-manifest-data-validation]: https://www.electionguard.vote/guide/Election_Manifest/#data-validation
[nist-nonce]: https://csrc.nist.gov/glossary/term/nonce
[ballot-encryption]: https://www.electionguard.vote/spec/0.95.0/5_Ballot_encryption/
[ballot-encryption]: ../../spec/web/6_Ballot_Encryption/

[cast-vote-record]: ../overview/Glossary.md#cast-vote-record
34 changes: 11 additions & 23 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,29 +56,17 @@ nav:
- Sample Data: develop/Sample_Data.md

- Specification:
- Current:
- Overview: spec/0.95.0/1_Overview.md
- Structure: spec/0.95.0/2_ElectionGuard_Structure.md
- Components: spec/0.95.0/3_ElectionGuard_Components.md
- Baseline Parameters: spec/0.95.0/4_Baseline_Parameters.md
- Ballot Encryption: spec/0.95.0/6_Ballot_Encryption.md
- Ballot Aggregation: spec/0.95.0/7_Ballot_Aggregation.md
- Election Record: spec/0.95.0/9_Election_Record.md
- Applications: spec/0.95.0/11_Applications.md
- Acknowledgements: spec/0.95.0/12_Acknowledgements.md
- Other Versions:
- v0.85.0: spec/0.85.0/1_Overview.md
- v0.95.0:
- Overview: spec/0.95.0/1_Overview.md
- Structure: spec/0.95.0/2_ElectionGuard_Structure.md
- Components: spec/0.95.0/3_ElectionGuard_Components.md
- Baseline Parameters: spec/0.95.0/4_Baseline_Parameters.md
- Ballot Encryption: spec/0.95.0/6_Ballot_Encryption.md
- Ballot Aggregation: spec/0.95.0/7_Ballot_Aggregation.md
- Election Record: spec/0.95.0/9_Election_Record.md
- Applications: spec/0.95.0/11_Applications.md
- Acknowledgements: spec/0.95.0/12_Acknowledgements.md
- v1.0.0: spec/1.0.0/1_Overview.md
- Official: spec/index.md
- Web:
- Overview: spec/web/1_Overview.md
- Structure: spec/web/2_ElectionGuard_Structure.md
- Components: spec/web/3_ElectionGuard_Components.md
- Baseline Parameters: spec/web/4_Baseline_Parameters.md
- Ballot Encryption: spec/web/6_Ballot_Encryption.md
- Ballot Aggregation: spec/web/7_Ballot_Aggregation.md
- Election Record: spec/web/9_Election_Record.md
- Applications: spec/web/11_Applications.md
- Acknowledgements: spec/web/12_Acknowledgements.md

- Contribute: contribute/index.md
plugins:
Expand Down

0 comments on commit 9395694

Please sign in to comment.