Skip to content

Commit e4665d4

Browse files
authored
Merge pull request #7 from planetf1/docupd1
2 parents 8bcb4b2 + c6ff345 commit e4665d4

File tree

5 files changed

+46
-14
lines changed

5 files changed

+46
-14
lines changed

docs/governance/tsc.md

Lines changed: 25 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,45 @@
11
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
22

3-
The Technical Steering Committee (TSC) is the leadership of the
4-
pq-code-package project. It's role is to:
3+
# Technical Steering Committee
54

6-
- Set the overall strategy of the project ie across all our algorithm
5+
The Technical Steering Committee (TSC) is the leadership of the pq-code-package project. It's role is to:
6+
7+
- Set the overall strategy of the project ie across all our algorithm
78
implementations & supporting subprojects
89
- Liase with the PQCA TAC providing feedback and raising issues and concerns
910
- resolve any issues within the project community
1011

1112
## Members
1213

13-
The initial TSC was created based on the intial contributors during the project inception.
14+
The TSC is open to everyone to contribute.
15+
16+
### Voting members
17+
18+
There are specific voting members as agreed at the initial TSC. These are:
19+
20+
- [Manuel Barbosa](https://github.com/mbbarbosa)
21+
- [Hanno Becker](https://github.com/hanno-becker)
22+
- [Nigel Jones](https://github.com/planetf1)
23+
- [Matthias J. Kannwischer](https://github.com/mkannwischer)
24+
- [Franziskus Kiefer](https://github.com/franziskuskiefer)
25+
- [Tiago Oliveira](https://github.com/tfaoliveira)
26+
- [John Schanck](https://github.com/jschanck)
27+
- [Douglas Stebila](https://github.com/dstebila)
28+
29+
### TSC Lead
1430

15-
Subsequent members may be voted onto the TSC, the process for doing so will be clarified at a later stage.
31+
The TSC lead is [Nigel Jones](https://github.com/planetf1)
1632

1733
## Meetings
1834

19-
Meetings are open to everyone, but only TSC members may vote.
35+
Meetings are open to everyone, but only TSC members may vote.
2036

2137
Minutes and recordings will generally be made available. If you are concerned about recording or minutes this may be noted, and recording/minuting then suspended for the appropriate discussion.
2238

23-
* [Link to agenda and minutes](https://github.com/pq-code-package/tsc/blob/main/meetings/index.md)
39+
- [Link to agenda and minutes](https://github.com/pq-code-package/tsc/blob/main/meetings/index.md)
2440

25-
* [PQCA calendar](https://pqca.org/calendar/) incorporates all scheduled TSC meetings
26-
- note that times are currently displayed in US Central time
41+
- [PQCA calendar](https://pqca.org/calendar/) incorporates all scheduled TSC meetings
2742

2843
## Issue Tracking
2944

30-
The [tsc](https://github.com/pq-code-package/tsc/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) is used to track discussions and actions at the TSC.
45+
The [tsc repo](https://github.com/pq-code-package/tsc/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) is used to track discussions and actions at the TSC.

docs/implementations/index.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
22

3+
# Implementations
4+
35
The PQ Code Package offers a variety of different implementations of ML-KEM.
46

57
These vary in certain characteristics in terms of:

docs/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,13 @@
11
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
22
# Introduction
33

4-
Welcome to the pq-code-package documentation.
4+
!!! info "Select one of the sections using the nav-bar at the top, or top-left."
5+
6+
The PQ Code Package project is a new open source project that aims to build high-assurance software implementations of standards-track post-quantum cryptography algorithms. The PQCP is a project within the Linux Foundation as part of the Post-Quantum Cryptography Alliance.
7+
8+
Our initial focus in the first phase of the project will be on the Module-Lattice-Based Key Encapsulation Mechanism (ML-KEM) algorithm. As the project grows, we intend to also produce implementations for ML-DSA and SLH-DSA, as well as other standards-track post-quantum algorithms.
9+
10+
We aim for implementations produced by the project to have assurances given either as a result of external audits or as a result of formal verification methods (or both).
11+
512

6-
Please select one of the section using the nav-bar at the top, or top-left.
713

docs/overview/pqca.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
2+
3+
# Post Quantum Cryptography Alliance (PQCA)
4+
25
_The alliance seeks to address cryptographic security challenges posed by quantum computing by producing high-assurance software implementations of standardized algorithms and supporting the continued development and standardization of new post-quantum algorithms with software for evaluation and prototyping._
36

47
- https://pqca.org/
58

6-
The pq-code-package is a project under the PQCA
9+
The pq-code-package is a project under the PQCA.
10+
11+
PQCA is a Linux Foundation project.
12+
13+
## Other PQCA subprojects
14+
15+
- [Open Quantum Safe](https://openquantumsafe.org)

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ nav:
9292
- Background to ML-KEM: overview/mlkem.md
9393
- Choosing an implementation: overview/choosing-implementation.md
9494
- Algorithm Implementations:
95-
- List of algorithms and characteristics: implementations/index.md
95+
- Implementations and characteristics: implementations/index.md
9696
- ML-KEM generic C implementation: implementations/mlkem-c-generic.md
9797
- ML-KEM optimized C (embedded): implementations/mlkem-c-embedded.md
9898
- ML-KEM optimized C (aarch64): implementations/mlkem-c-aarch64.md

0 commit comments

Comments
 (0)