diff --git a/docs/develop/Repositories.md b/docs/develop/Repositories.md index acb90db9..b4ba75f6 100644 --- a/docs/develop/Repositories.md +++ b/docs/develop/Repositories.md @@ -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] ##
ElectionGuard Python ![Python][python-logo]
@@ -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" diff --git a/docs/overview/Glossary.md b/docs/overview/Glossary.md index bae9df59..515830ca 100644 --- a/docs/overview/Glossary.md +++ b/docs/overview/Glossary.md @@ -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] -[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" diff --git a/docs/spec/0.85.0/1_Overview.md b/docs/spec/0.85.0/1_Overview.md deleted file mode 100644 index 250058a6..00000000 --- a/docs/spec/0.85.0/1_Overview.md +++ /dev/null @@ -1,8 +0,0 @@ -# ElectionGuard Specification ![Version 0.85.0][green-badge-0.85.0] - -!!! info "Download Specification" - No web version of this specification is available at this time. [Download specification here][spec-0.85.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/tag/v0.85.0 "Election Guard Specification" diff --git a/docs/spec/1.0.0/1_Overview.md b/docs/spec/1.0.0/1_Overview.md deleted file mode 100644 index b2a1c51e..00000000 --- a/docs/spec/1.0.0/1_Overview.md +++ /dev/null @@ -1,7 +0,0 @@ -# ElectionGuard Specification ![Version 1.0.0][yellow-badge-1.0.0] - -!!! attention "Under Development" - This version is unreleased. Star the repository and follow along for updates. - - -[yellow-badge-1.0.0]: https://img.shields.io/badge/Version-v1.0.0-yellow diff --git a/docs/spec/index.md b/docs/spec/index.md new file mode 100644 index 00000000..95061a61 --- /dev/null +++ b/docs/spec/index.md @@ -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. + + +[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" + + + + + diff --git a/docs/spec/0.95.0/11_Applications.md b/docs/spec/web/11_Applications.md similarity index 100% rename from docs/spec/0.95.0/11_Applications.md rename to docs/spec/web/11_Applications.md diff --git a/docs/spec/0.95.0/12_Acknowledgements.md b/docs/spec/web/12_Acknowledgements.md similarity index 100% rename from docs/spec/0.95.0/12_Acknowledgements.md rename to docs/spec/web/12_Acknowledgements.md diff --git a/docs/spec/0.95.0/1_Overview.md b/docs/spec/web/1_Overview.md similarity index 84% rename from docs/spec/0.95.0/1_Overview.md rename to docs/spec/web/1_Overview.md index a95feae6..c5293205 100644 --- a/docs/spec/0.95.0/1_Overview.md +++ b/docs/spec/web/1_Overview.md @@ -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 @@ -29,4 +29,5 @@ This specification can be used by expert reviewers to evaluate the details of th [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]: ../../ diff --git a/docs/spec/0.95.0/2_ElectionGuard_Structure.md b/docs/spec/web/2_ElectionGuard_Structure.md similarity index 100% rename from docs/spec/0.95.0/2_ElectionGuard_Structure.md rename to docs/spec/web/2_ElectionGuard_Structure.md diff --git a/docs/spec/0.95.0/3_ElectionGuard_Components.md b/docs/spec/web/3_ElectionGuard_Components.md similarity index 100% rename from docs/spec/0.95.0/3_ElectionGuard_Components.md rename to docs/spec/web/3_ElectionGuard_Components.md diff --git a/docs/spec/0.95.0/4_Baseline_Parameters.md b/docs/spec/web/4_Baseline_Parameters.md similarity index 100% rename from docs/spec/0.95.0/4_Baseline_Parameters.md rename to docs/spec/web/4_Baseline_Parameters.md diff --git a/docs/spec/0.95.0/6_Ballot_Encryption.md b/docs/spec/web/6_Ballot_Encryption.md similarity index 100% rename from docs/spec/0.95.0/6_Ballot_Encryption.md rename to docs/spec/web/6_Ballot_Encryption.md diff --git a/docs/spec/0.95.0/7_Ballot_Aggregation.md b/docs/spec/web/7_Ballot_Aggregation.md similarity index 100% rename from docs/spec/0.95.0/7_Ballot_Aggregation.md rename to docs/spec/web/7_Ballot_Aggregation.md diff --git a/docs/spec/0.95.0/9_Election_Record.md b/docs/spec/web/9_Election_Record.md similarity index 100% rename from docs/spec/0.95.0/9_Election_Record.md rename to docs/spec/web/9_Election_Record.md diff --git a/docs/use_cases/Precinct_Scan.md b/docs/use_cases/Precinct_Scan.md index 004e7b4f..83672dac 100644 --- a/docs/use_cases/Precinct_Scan.md +++ b/docs/use_cases/Precinct_Scan.md @@ -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 diff --git a/mkdocs.yml b/mkdocs.yml index 01a3a518..73f5c496 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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: