Merge pull request #5 from planetf1/initial

pq-code-package · May 1, 2024 · a6f9211 · a6f9211
2 parents db3aff0 + 80b31d2
commit a6f9211
Show file tree

Hide file tree

Showing 44 changed files with 75 additions and 80 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 name: 🐞 Bug
 description: File a bug/issue
 title: "bug: "

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 blank_issues_enabled: false
 contact_links:
   - name: Support Request

diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 name: Enhancement Tracking Issue
 description: Provide supporting details for an enhancement
 labels: [enhancement]

diff --git a/.github/ISSUE_TEMPLATE/improve_docs.yml b/.github/ISSUE_TEMPLATE/improve_docs.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 name: "Documentation Issue"
 description: Issues related to documentation.
 title: "docs: "

diff --git a/.github/labels.yml b/.github/labels.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 - name: bug
   description: Something isn't working
   color: b60205

diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: CC-BY-4.0
+#
 <!--  Thanks for sending a pull request! -->
 
 ## Proposed changes

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 name: ci 
 
 on:

diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -1,6 +1,6 @@
-# Copyright IBM Corp. All Rights Reserved.
 #
-# SPDX-License-Identifier: CC-BY-4.0
+# SPDX-License-Identifier: Apache-2.0
+#
 
 name: Deploy Docs (Github Pages)
 

diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 name: 'Close stale issues and PRs'
 on:
   schedule:

diff --git a/CODEOWNERS b/CODEOWNERS
@@ -1 +1,4 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 * @planetf1
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # Maintainers
 
 ## Active Maintainers

diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # Welcome to the documentation template
 
 This repository serves as a template for creating documentation for projects. The template utilizes MkDocs (documentation at [mkdocs.org](https://www.mkdocs.org)) and the theme Material for MkDocs (documentation at [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)). Material adds a number of extra features to MkDocs, and repositories can take advantage of the theme's [Insiders](https://squidfunk.github.io/mkdocs-material/insiders/) capabilities.

diff --git a/docs/concepts/concept-1.md b/docs/concepts/concept-1.md
diff --git a/docs/concepts/concept-2.md b/docs/concepts/concept-2.md
diff --git a/docs/concepts/concept-3.md b/docs/concepts/concept-3.md
diff --git a/docs/contributing/asking-a-question.md b/docs/contributing/asking-a-question.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # Asking a Question
 
 !!! tip

diff --git a/docs/contributing/charter.md b/docs/contributing/charter.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/contributing/code-of-conduct.md b/docs/contributing/code-of-conduct.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/contributing/how-to-contribute.md b/docs/contributing/how-to-contribute.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # How to Contribute
 
 ## Ways to Contribute

diff --git a/docs/contributing/reporting-a-bug.md b/docs/contributing/reporting-a-bug.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # Reporting a Bug
 
 To report a bug, submit an issue in our public issue trackers on Github.

diff --git a/docs/contributing/reporting-a-security-issue.md b/docs/contributing/reporting-a-security-issue.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/contributing/requesting-a-change.md b/docs/contributing/requesting-a-change.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # Requesting a Change
 
 Pq-code-package highly values every idea or contribution from our community, and

diff --git a/docs/contributing/tsc.md b/docs/contributing/tsc.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/faqs.md b/docs/faqs.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # Frequently Asked Questions
 
 ## Topic 1

diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md
diff --git a/docs/getting-started/running.md b/docs/getting-started/running.md
diff --git a/docs/glossary.md b/docs/glossary.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 **term**
 
 : definition

diff --git a/docs/guides/developers.md b/docs/guides/developers.md
diff --git a/docs/guides/operations.md b/docs/guides/operations.md
diff --git a/docs/guides/upgrading.md b/docs/guides/upgrading.md
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,4 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
 # Introduction
 
 Welcome to the pq-code-package documentation.

diff --git a/docs/overview/choosing-implementation.md b/docs/overview/choosing-implementation.md
@@ -0,0 +1,7 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
+# Choosing an ML-KEM implementation
+
+The implementations in this repository vary in terms of:
+- Implementation Language
+- Auditing
+- Formal Verification
diff --git a/docs/overview/mlkem.md b/docs/overview/mlkem.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/overview/pqca.md b/docs/overview/pqca.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/overview/purpose.md b/docs/overview/purpose.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/references/architecture.md b/docs/references/architecture.md
diff --git a/docs/references/commands.md b/docs/references/commands.md
diff --git a/docs/references/roadmap.md b/docs/references/roadmap.md
diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
diff --git a/docs/tutorials/tutorial-1.md b/docs/tutorials/tutorial-1.md
diff --git a/docs/tutorials/tutorial-2.md b/docs/tutorials/tutorial-2.md
diff --git a/docs/tutorials/tutorial-3.md b/docs/tutorials/tutorial-3.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,3 +1,6 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 site_name: PQ Code Package
 site_url: https://docs.pqcodepackage.org/latest/
 repo_name: pq-code-package/documentation
@@ -83,30 +86,26 @@ extra:
     provider: mike
 nav:
   - Introduction: index.md
-  - Concepts:
-    - Concept 1: concepts/concept-1.md
-    - Concept 2: concepts/concept-2.md
-    - Concept 3: concepts/concept-3.md
-  - Getting Started:
-    - Installation: getting-started/installation.md
-    - Running: getting-started/running.md
-  - Tutorials:
-    - Introduction: tutorials/index.md
-    - Tutorial 1: tutorials/tutorial-1.md
-    - Tutorial 2: tutorials/tutorial-2.md
-    - Tutorial 3: tutorials/tutorial-3.md
-  - Guides:
-    - Operations: guides/operations.md
-    - Developers: guides/developers.md
-    - Upgrading: guides/upgrading.md
-  - References:
-    - Architecture: references/architecture.md
-    - Commands: references/commands.md
-    - Roadmap: references/roadmap.md
+  - Overview:
+    - About the PQCA: overview/pqca.md
+    - Purpose of pq-code-package: overview/purpose.md
+    - Background to ML-KEM: overview/mlkem.md
+    - Choosing an implementation: overview/choosing-implementation.md
+  - Algorithm Implementations:
+    - List of algorithms 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
+    - ML-KEM libjade (jasmin): implementations/mlkem-libjade.md
+    - ML-KEM libcrux (rust): implementations/mlkem-rust-libcrux.md
   - Contributing:
+    - Charter: contributing/charter.md
+    - Code of Conduct: contributing/code-of-conduct.md
     - How to Contribute: contributing/how-to-contribute.md
     - Reporting a Bug: contributing/reporting-a-bug.md
+    - Reporting a Security Issue: contributing/reporting-a-security-issue.md
     - Requesting a Change: contributing/requesting-a-change.md
-    - Asking a Question: contributing/asking-a-question.md
+    - Getting Help or Chat: contributing/asking-a-question.md
+    - Technical Steering Committee: contributing/tsc.md
   - FAQs: faqs.md
   - Glossary: glossary.md
diff --git a/requirements.txt b/requirements.txt
@@ -1,2 +1,5 @@
+#
+# SPDX-License-Identifier: Apache-2.0
+#
 mkdocs-material
 mike