Skip to content

Commit

Permalink
♻️ Move CONTRIBUTING.md into book (#20)
Browse files Browse the repository at this point in the history
  • Loading branch information
clabby authored Feb 13, 2024
1 parent b4b3ba7 commit b0df2c0
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 11 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<p align="center">
<a href="#whats-kona">What's Kona?</a> •
<a href="#overview">Overview</a> •
<a href="CONTRIBUTING.md">Contributing</a> •
<a href="https://static.optimism.io/kona/CONTRIBUTING.html">Contributing</a> •
<a href="#book">Book</a> •
<a href="#credits">Credits</a>
</p>
Expand Down
8 changes: 3 additions & 5 deletions CONTRIBUTING.md → book/src/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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)

Expand All @@ -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
11 changes: 6 additions & 5 deletions book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit b0df2c0

Please sign in to comment.