diff --git a/.gitignore b/.gitignore index 367d4db4df2f7..41f6d2a5e3c36 100644 --- a/.gitignore +++ b/.gitignore @@ -20,6 +20,7 @@ Session.vim /book/ /build/ /target +library/target *.rlib *.rmeta *.mir diff --git a/doc/src/SUMMARY.md b/doc/src/SUMMARY.md index db5018121be02..9d445fc7dc10c 100644 --- a/doc/src/SUMMARY.md +++ b/doc/src/SUMMARY.md @@ -3,8 +3,8 @@ [Introduction](intro.md) - [General Rules](./general-rules.md) - - [Challenge Template](./template.md) - - [Tool application](./todo.md) + - [Challenge Template](./challenge_template.md) + - [Tool Application Template](./tool_template.md) - [Verification Tools](./tools.md) - [Kani](./tools/kani.md) diff --git a/doc/src/template.md b/doc/src/challenge_template.md similarity index 100% rename from doc/src/template.md rename to doc/src/challenge_template.md diff --git a/doc/src/general-rules.md b/doc/src/general-rules.md index c681e9bb8953d..4f419decbdf6b 100644 --- a/doc/src/general-rules.md +++ b/doc/src/general-rules.md @@ -39,7 +39,7 @@ A proposed solution to a verification problem will only **be reviewed** if all t * The contribution must be automated and should be checked and pass as part of the PR checks. * All tools used by the solution must be in [the list of accepted tools](tools.md#approved-tools), and previously integrated in the repository. - If that is not the case, please submit a separate [tool application first](todo.md). + If that is not the case, please submit a separate [tool application first](./general-rules.md#tool-applications). * There is no restriction on the number of contributors for a solution. Make sure you have the rights to submit your solution and that all contributors are properly mentioned. * The solution cannot impact the runtime logic of the standard library unless the change is proposed and incorporated @@ -56,7 +56,7 @@ The type of obstacles users face may depend on which part of the standard librar Everyone is welcome to submit new challenge proposals for review by our committee. Follow the following steps to create a new proposal: -1. Create a tracking issue using the Issue template [Challenge Proposal](template.md) for your challenge. +1. Create a tracking issue using the [challenge template](./challenge_template.md) for your challenge. 2. In your fork of this repository do the following: 1. Copy the template file (`book/src/challenge_template.md`) to `book/src/challenges/-.md`. 2. Fill in the details according to the template instructions. @@ -69,7 +69,7 @@ Follow the following steps to create a new proposal: Solutions must be automated using one of the tools previously approved and listed [here](tools.md#approved-tools): -* Any new tool that participants want to enable will require an application using the Issue template [Tool application](todo.md). +* Any new tool that participants want to enable will require an application using the [tool application template](./tool_template.md). * The tool will be analyzed by an independent committee consisting of members from the Rust open-source developers and AWS * A new tool application should clearly specify the differences to existing techniques and provide sufficient background of why this is needed. diff --git a/doc/src/todo.md b/doc/src/todo.md deleted file mode 100644 index 50fed3f03274b..0000000000000 --- a/doc/src/todo.md +++ /dev/null @@ -1,3 +0,0 @@ -# 🚧 Under Construction 🚧 - -This section is still under construction. Please check it back again soon and we’ll have more details for you. \ No newline at end of file diff --git a/.github/TOOL_REQUEST_TEMPLATE.md b/doc/src/tool_template.md similarity index 100% rename from .github/TOOL_REQUEST_TEMPLATE.md rename to doc/src/tool_template.md