diff --git a/README.md b/README.md index 0017a8d4..cc58a8f7 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@

What's Kona?Overview • - Contributing • + ContributingBookCredits

diff --git a/CONTRIBUTING.md b/book/src/CONTRIBUTING.md similarity index 87% rename from CONTRIBUTING.md rename to book/src/CONTRIBUTING.md index 4a95a77a..8e154a47 100644 --- a/CONTRIBUTING.md +++ b/book/src/CONTRIBUTING.md @@ -1,7 +1,7 @@ # Contributing -Thank you for wanting to contribute! Before contributing to this repository, please read through this document, the -[book][book], and discuss the change you wish to make via issue or in the development telegram. +Thank you for wanting to contribute! Before contributing to this repository, please read through this document and +discuss the change you wish to make via issue or in the development telegram. ## Dependencies @@ -14,7 +14,7 @@ Before working with this repository locally, you'll need to install several depe **Optional** -- [mdbook](https://github.com/rust-lang/mdBook) to contribute to the [book][book] +- [mdbook](https://github.com/rust-lang/mdBook) to contribute to the [book](/) - [mdbook-template](https://github.com/sgoudham/mdbook-template) - [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid) @@ -28,5 +28,3 @@ Before working with this repository locally, you'll need to install several depe and in rustdoc comments. 1. Once you have sign-off from a maintainer, you may merge your pull request yourself if you have permissions to do so. If not, the maintainer who approves your pull request will add it to the merge queue. - -[book]: https://static.optimism.io/kona diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 5376d51c..7d0960e6 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -2,9 +2,10 @@ - [Introduction](./intro.md) - [Fault Proof Program Development](./fpp-dev/intro.md) - - [Environment](./fpp-dev/env.md) - - [Supported Targets](./fpp-dev/targets.md) - - [Prologue](./fpp-dev/prologue.md) - - [Execution](./fpp-dev/execution.md) - - [Epilogue](./fpp-dev/epilogue.md) + - [Environment](./fpp-dev/env.md) + - [Supported Targets](./fpp-dev/targets.md) + - [Prologue](./fpp-dev/prologue.md) + - [Execution](./fpp-dev/execution.md) + - [Epilogue](./fpp-dev/epilogue.md) - [Glossary](./glossary.md) +- [Contributing](./CONTRIBUTING.md)