Merge pull request #4 from planetf1/initial

planetf1 · web-flow · commit db3aff057a78 · 2024-05-01T11:46:44.000+01:00
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
@@ -9,15 +9,15 @@ body:
         _The more information you share, the faster we can help you._
         Prior to opening the issue, please make sure that you:
         - Use English (EN/US) to communicate.
-        - Search the [open issues](https://github.com/hyperledger-labs/documentation-template/issues) to avoid duplicating the issue.
+        - Search the open issues to avoid duplicating the issue.
 
   - type: textarea
     id: problem
     attributes:
       label: What happened?
       description: |
         Please provide as much info as possible. Not doing so may result in your bug not being addressed in a timely manner.
-        If this matter is security related, please disclose it privately via security@hyperledger.org
+        If this matter is security related, please disclose it privately via TODO
     validations:
       required: true
 
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
 blank_issues_enabled: false
 contact_links:
   - name: Support Request
-    url: https://discord.gg/hyperledger
-    about: Support request or question relating to Hyperledger Docs
+    url: https://discord.com/invite/xyVnwzfg5R
+    about: Support request or question relating to pq-code-package Docs
diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml
@@ -8,7 +8,7 @@ body:
         _The more information you share, the faster we can help you._
         Prior to opening the issue, please make sure that you:
         - Use English (EN/US) to communicate.
-        - Search the [open issues](https://github.com/hyperledger-labs/documentation-template/issues) to avoid duplicating the issue.
+        - Search the [open issues](https://github.com/pqca/pq-code-package/documentation/issues) to avoid duplicating the issue.
 
   - type: textarea
     id: enhancement
diff --git a/.github/ISSUE_TEMPLATE/improve_docs.yml b/.github/ISSUE_TEMPLATE/improve_docs.yml
@@ -9,7 +9,7 @@ body:
         _The more information you share, the faster we can help you._
         Prior to opening the issue, please make sure that you:
         - Use English (EN/US) to communicate.
-        - Search the [open issues](https://github.com/hyperledger-labs/documentation-template/issues) to avoid duplicating the issue.
+        - Search the [open issues](https://github.com/pqca/pq-code-package/documentation/issues) to avoid duplicating the issue.
 
   - type: textarea
     id: current-state
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1 @@
+.vscode
diff --git a/docs/contributing/asking-a-question.md b/docs/contributing/asking-a-question.md
@@ -8,10 +8,10 @@
     * review [How to Ask Technical Questions to Get Quality Answers](https://opensource.com/life/16/10/how-ask-technical-questions) prior to asking your question.
 
 ## Chat
-[Hyperledger’s Discord server](https://discord.gg/hyperledger) is the place to go for real-time chat about everything from quick help to involved discussions.
+[PQCA's Discord server](https://discord.com/invite/xyVnwzfg5R) is the place to go for real-time chat about everything from quick help to involved discussions.
 
-For general Hyperledger _PROJECT_ discussions, join the Discord server and visit #_PROJECT_.
+For general pq-code-package discussions, join the Discord server and visit #pqca-code-package.
 
 ## Mailing Lists
-The Hyperledger _PROJECT_ mailing list is hosted by the Hyperledger Foundation: https://lists.hyperledger.org. 
+The pq-code-package mailing lists are hosted by the pqca Foundation: https://pqca.org . 
 
diff --git a/docs/contributing/how-to-contribute.md b/docs/contributing/how-to-contribute.md
@@ -3,7 +3,7 @@
 ## Ways to Contribute
 
 Contributions from the development community help improve the capabilities of
-Hyperledger _PROJECT_. These contributions are the most effective way to
+Pq-code-package. These contributions are the most effective way to
 make a positive impact on the project.
 
 Ways you can contribute:
@@ -17,7 +17,7 @@ Issues can be found in GitHub. Any unassigned items are probably still open. Whe
 
 ## The Commit Process
 
-Hyperledger _PROJECT_ is Apache 2.0 licensed and accepts contributions via GitHub pull requests. When contributing code, please follow these guidelines:
+Pq-code-package is Apache 2.0 licensed and accepts contributions via GitHub pull requests. When contributing code, please follow these guidelines:
 
 * Fork the repository and make your changes in a feature branch
 * Include unit and integration tests for any new features and updates to existing tests
@@ -32,6 +32,7 @@ enhancement. Here are some example scenarios:
 * If a pull request adds a feature but also fixes two bugs, the pull request should have three commits: one commit for the feature change and two commits for the bug fixes.
 * If a PR is opened with five commits that contain changes to fix a single issue, the PR should be rebased to a single commit.
 * If a PR is opened with several commits, where the first commit fixes one issue and the rest fix a separate issue, the PR should be rebased to two commits (one for each issue).
+* Do not squash your commits until the final stage of review. This helps reviewers and approvers understand what has changed between cycles.
 
 !!! important
     Your pull request should be rebased against the current master branch. Do not merge the current master branch in with your topic branch. Do not use the Update Branch button provided by GitHub on the pull request page.
@@ -53,7 +54,7 @@ Your commit email address must match your GitHub email address. For more informa
 A pull request cannot merged until it has passed these status checks:
 
 * The build must pass all checks
-* The PR must be approved by at least two reviewers without any
+* The PR must be approved by at least one reviewer without any
   outstanding requests for changes
 
 ## Inclusive Language
@@ -64,4 +65,4 @@ A pull request cannot merged until it has passed these status checks:
 - We suggest to refer to [Microsoft bias free writing guidelines](https://learn.microsoft.com/en-us/style-guide/bias-free-communication) and [Google inclusive doc writing guide](https://developers.google.com/style/inclusive-documentation) as starting points.
 
 ## Credits
-This document is based on [Hyperledger Sawtooth's Contributing documentation](https://github.com/hyperledger/sawtooth-docs/blob/main/community/contributing.md).
+This document has been adapted for pq-code-package based on based on [Hyperledger Sawtooth's Contributing documentation](https://github.com/hyperledger/sawtooth-docs/blob/main/community/contributing.md).
diff --git a/docs/contributing/reporting-a-bug.md b/docs/contributing/reporting-a-bug.md
@@ -1,6 +1,6 @@
 # Reporting a Bug
 
-To report a bug, submit an issue in our public [issue tracker].
+To report a bug, submit an issue in our public issue trackers on Github.
 
 When reporting an issue, please provide as much detail as possible about how to reproduce it. If possible, explain how to reproduce the issue. Details are very helpful. Please include the following information:
 
@@ -11,4 +11,4 @@ When reporting an issue, please provide as much detail as possible about how to
 * Actual results
 * Expected results
 
-  [issue tracker]: https://github.com/hyperledger/_PROJECT_/issues
+
diff --git a/docs/contributing/requesting-a-change.md b/docs/contributing/requesting-a-change.md
@@ -1,18 +1,14 @@
 # Requesting a Change
 
-Hyperledger _PROJECT_ is a powerful tool which serves a wide range of use cases.
-Put yourself in our shoes – with a project of this size, it can be challenging
-to maintain existing functionality while constantly adding new features at the
-same time. We highly value every idea or contribution from our community, and
+Pq-code-package highly values every idea or contribution from our community, and
 we kindly ask you to take the time to read the following guidelines before 
-submitting your change request in our public [issue tracker]. This will help us 
+submitting your change request in our public issue trackers. This will help us 
 better understand the proposed change, and how it will benefit the community.
 
 This guide is our best effort to explain the criteria and reasoning behind our
 decisions when evaluating change requests and considering them for
 implementation. 
 
-  [issue tracker]: https://github.com/hyperledger/_PROJECT_/issues
 
 ## Before creating an issue
 
@@ -44,7 +40,7 @@ evaluating new ideas, it's essential to seek input from other users and consider
 alternative viewpoints. This approach helps to implement new features in a way
 that benefits a large number of users.
 
-  [Discord server]: https://discord.gg/hyperledger
+  [Discord server]: https://discord.com/invite/xyVnwzfg5R
 
 ## Issue template
 
@@ -79,7 +75,7 @@ be inferred from the title.
 
 Before describing your idea, you can provide additional context for us to
 understand what you are trying to achieve. Explain the circumstances
-in which you're using Hyperledger _PROJECT_, and what you _think_ might be
+in which you're using pq-code-package, and what you _think_ might be
 relevant. Don't write about the change request here.
 
 !!! success "Why we need this"
@@ -88,7 +84,7 @@ relevant. Don't write about the change request here.
 ### Description
 
 Next, provide a detailed and clear description of your idea. Explain why your 
-idea is relevant to Hyperledger _PROJECT_ and must be implemented here, and not
+idea is relevant to pq-code-package and must be implemented here, and not
 in one of its dependencies.
 
 -   __Explain the <u>what</u>, not the <u>why</u>__ – don't explain
@@ -142,14 +138,14 @@ elsewhere, please provide an example by showcasing
 it and describing how it was implemented and incorporated.
 
 !!! success "Why we need this"
-    Illustrations and visuals can help us maintainers better understand and envision your idea. Screenshots, sketches, or mockups can create an additional level of detail and clarity that text alone may not be able to convey. Also, seeing how your idea has been implemented in other projects can help us understand its potential impact and feasibility in Hyperledger _PROJECT_, which helps us maintainers evaluate and triage change requests.
+    Illustrations and visuals can help us maintainers better understand and envision your idea. Screenshots, sketches, or mockups can create an additional level of detail and clarity that text alone may not be able to convey. Also, seeing how your idea has been implemented in other projects can help us understand its potential impact and feasibility in pq-code-package, which helps us maintainers evaluate and triage change requests.
 
 ### Checklist
 
 Thanks for following the change request guide and creating a high-quality 
 change request. This section ensures that you have read this guide and have
 worked to your best knowledge to provide us with every piece of information to 
-review your idea for Hyperledger _PROJECT_.
+review your idea for pq-code-package.
 
 __We'll take it from here.__
 
diff --git a/docs/implementations/index.md b/docs/implementations/index.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/implementations/mlkem-c-aarch64.md b/docs/implementations/mlkem-c-aarch64.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/implementations/mlkem-c-embedded.md b/docs/implementations/mlkem-c-embedded.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/implementations/mlkem-c-generic.md b/docs/implementations/mlkem-c-generic.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/implementations/mlkem-libjade.md b/docs/implementations/mlkem-libjade.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/implementations/mlkem-rust-libcrux.md b/docs/implementations/mlkem-rust-libcrux.md
@@ -0,0 +1 @@
+<!-- SPDX-License-Identifier: CC-BY-4.0 -->
diff --git a/docs/index.md b/docs/index.md
@@ -1,131 +1,7 @@
 # Introduction
 
-This repository has been populated with a basic getting-started structure
-that we can extend for the PQ code package project.
+Welcome to the pq-code-package documentation.
 
-Some todos remain, see below for the list.
+In this version, only the **Contributing** section has been
+customized.
 
-During the Hackathon we can hopefully start building this site.
-
-
-## Configuration Updates
-
-### Project Logo
-
-Replace the file `docs/assets/project-logo.png` with the logo for your project.
-
-!!! tip
-
-    White logos with a transparent background works best for the project logo.
-
-!!! warning Logo Filename
-
-    If you use a different name than `project-logo.png`, you will also need to update the `mkdocs.yml` file to replace the `theme.logo` tag to reflect the correct filename. Example:
-
-    !!! example
-        ``` yaml
-        theme:
-          logo: assets/name-of-logo-file.png
-        ```
-
-### Project Icon
-
-Replace the file `docs/assets/project-icon.png` with the icon for your project.
-
-!!! tip
-
-    Color or dark icons works best for the project icon.
-
-!!! warning Icon Filename
-
-    If you use a different name than `project-icon.png`, you will also need to update the `mkdocs.yml` file to replace the `theme.favicon` tag to reflect the correct filename. Example:
-
-    !!! example
-        ``` yaml
-        theme:
-          favicon: assets/name-of-icon-file.png
-        ```
-
-## Documentation Updates
-
-### Overall
-
-Find and replace the use of `_PROJECT_` with the name of your project in all markdown files and the `mkdocs.yml` file.
-
-### Introduction
-
-Update the `docs/index.md` file to provide an introduction to the project.
-
-### Concepts
-
-The `docs/concepts` directory will contain information about the relevant concepts for your project. Currently there are placeholders for three concepts (`docs/concepts/concepts-[123].md`). You can remove these files and add a separate markdown file for each of the relevant concepts. Then modify the `mkdocs.yml` `nav` section to reflect the concept name and pointer to the concept. The relevant portion of the `mkdocs.yml` file is:
-
-!!! example
-    ``` yaml
-    nav:
-     - Concepts:
-       - Concept 1: concepts/concept-1.md
-       - Concept 2: concepts/concept-2.md
-       - Concept 3: concepts/concept-3.md
-    ```
-
-### Getting Started
-
-The files in the Getting Started topic are intended to help people get up and running with your project. 
-
-* Installation (`docs/getting-started/installation.md`) - provide details on how to install the project.
-* Running (`docs/getting-started/running.md`) - provide details on how to run the project.
-
-### Tutorials
-
-The `docs/tutorials` directory will contain tutorials that the use can use to learn about your project. There is an introduction page that you can use to describe your tutorials at a high level. In addition, there are placeholders for three tutorials (`docs/tutorials/tutorials-[123].md`). You can remove the placeholder files and add a separate markdown file for each of the relevant tutorials. Then modify the `mkdocs.yml` `nav` section to reflect the tutorial name, and pointer to the tutorial. The relevant portion of the `mkdocs.yml` file is:
-
-!!! example
-    ``` yaml
-    nav:
-     - Tutorials:
-       - Introduction: tutorials/index.md
-       - Tutorial 1: tutorials/tutorial-1.md
-       - Tutorial 2: tutorials/tutorial-2.md
-       - Tutorial 3: tutorials/tutorial-3.md
-    ```
-### Guides
-
-In the Guides section, there are three placeholders:
-1. Operations (`docs/guides/operations.md`) - used to guide an operator of your project through critical tasks.
-2. Developers (`docs/guides/developers.md`) - used to guide a developer using your project through critical tasks.
-3. Upgrading (`docs/guides/upgrading.md`) - used to guide someone through upgrading from one version of your project to another.
-
-!!! note
-    The placeholders are not all inclusive. Please add any other reference material that is needed and update the `mkdocs.yml` `nav` section to ensure these references show up on the documentation site.
-
-### References
-
-In the References section, there are three placeholders:
-
-1. Architecture (`docs/references/architecture.md`) - describe the architecture for the project in this file.
-2. Commands (`docs/references/commands.md`) - describe the different commands that are available for running the project.
-3. Roadmap (`docs/references/roadmap.md`) - describe the roadmap for the project.
-
-!!! note
-    The placeholders are not all inclusive. Please add any other reference material that is needed and update the `mkdocs.yml` `nav` section to ensure these references show up on the documentation site.
-
-### Contributing
-
-The files in the Contributing topic are intended to help people who are interested in contributing to your project.
-
-!!! note
-    Sample text has been provided in these files. Feel free to modify to fit your project.
-
-* How to Contribute (`docs/contributing/how-to-contribute.md`) - provide details on how to contribute to the project.
-* Reporting a Bug (`docs/contributing/reporting-a-bug.md`) - provide details on how to report a bug.
-* Requesting a Change (`docs/contributing/requesting-a-change.md`) - provide details on how to request a change. 
-* Asking a Question (`docs/contributing/asking-a-question.md`) - provide details on how and where to ask questions.
-
-### FAQs
-
-There is a placeholder (`docs/faqs.md`) for including any frequently asked questions about the project. Please update this document whenever you come across a frequently asked question.
-
-### Glossary
-
-There is a placeholder (`docs/glossary.md`) for capturing terms that are used in the documentation and with relation to the project. Please update the glossary to include relevant terms and definitions.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<!-- SPDX-License-Identifier: CC-BY-4.0 -->`