Skip to content

Commit

Permalink
Merge pull request #7 from planetf1/docupd1
Browse files Browse the repository at this point in the history
  • Loading branch information
planetf1 authored Jun 3, 2024
2 parents 8bcb4b2 + c6ff345 commit e4665d4
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 14 deletions.
35 changes: 25 additions & 10 deletions docs/governance/tsc.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,45 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->

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

- Set the overall strategy of the project ie across all our algorithm
The Technical Steering Committee (TSC) is the leadership of the pq-code-package project. It's role is to:

- Set the overall strategy of the project ie across all our algorithm
implementations & supporting subprojects
- Liase with the PQCA TAC providing feedback and raising issues and concerns
- resolve any issues within the project community

## Members

The initial TSC was created based on the intial contributors during the project inception.
The TSC is open to everyone to contribute.

### Voting members

There are specific voting members as agreed at the initial TSC. These are:

- [Manuel Barbosa](https://github.com/mbbarbosa)
- [Hanno Becker](https://github.com/hanno-becker)
- [Nigel Jones](https://github.com/planetf1)
- [Matthias J. Kannwischer](https://github.com/mkannwischer)
- [Franziskus Kiefer](https://github.com/franziskuskiefer)
- [Tiago Oliveira](https://github.com/tfaoliveira)
- [John Schanck](https://github.com/jschanck)
- [Douglas Stebila](https://github.com/dstebila)

### TSC Lead

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

## Meetings

Meetings are open to everyone, but only TSC members may vote.
Meetings are open to everyone, but only TSC members may vote.

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.

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

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

## Issue Tracking

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.
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.
2 changes: 2 additions & 0 deletions docs/implementations/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->

# Implementations

The PQ Code Package offers a variety of different implementations of ML-KEM.

These vary in certain characteristics in terms of:
Expand Down
10 changes: 8 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->
# Introduction

Welcome to the pq-code-package documentation.
!!! info "Select one of the sections using the nav-bar at the top, or top-left."

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.

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.

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).


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

11 changes: 10 additions & 1 deletion docs/overview/pqca.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
<!-- SPDX-License-Identifier: CC-BY-4.0 -->

# Post Quantum Cryptography Alliance (PQCA)

_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._

- https://pqca.org/

The pq-code-package is a project under the PQCA
The pq-code-package is a project under the PQCA.

PQCA is a Linux Foundation project.

## Other PQCA subprojects

- [Open Quantum Safe](https://openquantumsafe.org)
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ nav:
- Background to ML-KEM: overview/mlkem.md
- Choosing an implementation: overview/choosing-implementation.md
- Algorithm Implementations:
- List of algorithms and characteristics: implementations/index.md
- Implementations and characteristics: implementations/index.md
- ML-KEM generic C implementation: implementations/mlkem-c-generic.md
- ML-KEM optimized C (embedded): implementations/mlkem-c-embedded.md
- ML-KEM optimized C (aarch64): implementations/mlkem-c-aarch64.md
Expand Down

0 comments on commit e4665d4

Please sign in to comment.