Skip to content

Commit

Permalink
docs: Add link to gh pages from README (#17)
Browse files Browse the repository at this point in the history
Co-authored-by: Markus Legner <[email protected]>
  • Loading branch information
gdanezis and mlegner authored Jun 10, 2024
1 parent 548135f commit 189c82f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,9 @@ availability and reliability even in the presence of Byzantine faults.

## Documentation

Our documentation is available at **TBD**; it is generated using
[mdBook](https://rust-lang.github.io/mdBook/) from source files in the [`docs/`](./docs/) directory.
Our documentation is available on [GitHub Pages](https://mystenlabs.github.io/walrus-docs); it is
generated using [mdBook](https://rust-lang.github.io/mdBook/) from source files in the
[`docs/`](./docs/) directory.

You can also build and access the documentation locally (assuming you have Rust installed):

Expand Down

0 comments on commit 189c82f

Please sign in to comment.