Fix tables and broken links

jaisnan · Jun 12, 2024 · 2ee922b · 2ee922b
1 parent 30f2648
commit 2ee922b
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 25 deletions.
diff --git a/doc/src/SUMMARY.md b/doc/src/SUMMARY.md
@@ -4,6 +4,7 @@
 
 - [General Rules](./general-rules.md)
   - [Challenge Template](./template.md)
+  - [Tool application](./todo.md)
 
 - [Verification Tools](./tools.md)
   - [Kani](./tools/kani.md)

diff --git 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](todo.md).
 * 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](./todo.md) for your challenge.
+1. Create a tracking issue using the Issue template [Challenge Proposal](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/<ID_NUMBER>-<challenge-name>.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 Issue template [Tool application](todo.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/intrinsics-memory.md b/doc/src/intrinsics-memory.md
@@ -23,8 +23,8 @@ Annotate Rust core::intrinsics functions that manipulate raw pointers with their
 
 Intrinsic functions to be annotated with safety contracts
 
-|Function	|Location	|
-|---	|---	|
+| Function | Location |
+|---------|---------|
 |typed_swap | core::intrisics |
 |vtable_size| core::intrisics |
 |vtable_align| core::intrisics |
@@ -50,8 +50,8 @@ Intrinsic functions to be annotated with safety contracts
 
 All the following usages of intrinsics were proven safe:
 
-|Function	|Location	|
-|---	|---	|
+| Function | Location |
+|---------|---------|
 |copy_from_slice	| core::slice |
 |parse_u64_into	| std::fmt |
 |swap | core::mem |
@@ -62,8 +62,8 @@ All the following usages of intrinsics were proven safe:
 
 Annotate and verify all the functions that below that expose intrinsics with safety contracts
 
-|Function	|Location	|
-|---	|---	|
+| Function | Location |
+|---------|---------|
 |copy_from_slice	| std::ptr |
 |parse_u64_into	| std::ptr |
 |swap | std::ptr |
@@ -72,7 +72,6 @@ Annotate and verify all the functions that below that expose intrinsics with saf
 
 
 
-
 ### List of UBs
 
 All proofs must automatically ensure the absence of the following undefined behaviors [ref](https://github.com/rust-lang/reference/blob/142b2ed77d33f37a9973772bd95e6144ed9dce43/src/behavior-considered-undefined.md):

diff --git a/doc/src/template.md b/doc/src/template.md
@@ -25,29 +25,21 @@
 
 *Mention any assumption that users may make. Example, "assuming the usage of Stacked Borrows".*
 
-### Success Criteria*
+### Success Criteria
 
 *Here are some examples of possible criteria:*
 
 All the following unsafe functions must be annotated with safety contracts and the contracts have been verified:
 
-|Function	|Location	|
-|---	|---	|
-|	|	|
-|	|	|
-|	|	|
-|	|	|
-|	|	|
+| Function | Location |
+|---------|---------|
+|  abc   |  def    |
 
 At least N of the following usages were proven safe:
 
-|Function	|Location	|
-|---	|---	|
-|	|	|
-|	|	|
-|	|	|
-|	|	|
-|	|	|
+| Function | Location |
+|---------|---------|
+|  xyz   |  123   |
 
 All proofs must automatically ensure the absence of the following undefined behaviors [ref](https://github.com/rust-lang/reference/blob/142b2ed77d33f37a9973772bd95e6144ed9dce43/src/behavior-considered-undefined.md):