From 18ce3ed28be00dfd9bb3902b6df83814817a8874 Mon Sep 17 00:00:00 2001 From: Markus Legner Date: Fri, 14 Jun 2024 15:28:49 +0200 Subject: [PATCH] docs: add some self-referential pointers --- README.md | 7 ++++--- docs/README.md | 4 ++++ docs/usage/examples.md | 11 ++++++++++- docs/walrus-sites/intro.md | 4 +++- 4 files changed, 21 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index de54f83f..d3cb0747 100644 --- a/README.md +++ b/README.md @@ -7,9 +7,10 @@ availability and reliability even in the presence of Byzantine faults. ## Documentation -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. +Our documentation is available [as a Walrus Site](https://docs.walrus.site) (see [the +documentation](https://docs.walrus.site/walrus-sites/intro.html) for further information on what +this means) and 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): diff --git a/docs/README.md b/docs/README.md index 58af97b9..8ea58f25 100644 --- a/docs/README.md +++ b/docs/README.md @@ -5,6 +5,10 @@ designed specifically for large binary files, or "blobs". Walrus focuses on prov solution for storing unstructured content on decentralized storage nodes while ensuring high availability and reliability even in the presence of Byzantine faults. +Fun fact: If you are viewing this site at , you are fetching this from +Walrus behind the scenes. See the [Walrus Sites chapter](./walrus-sites/intro.md) for further +details on how this works. + ## Features - **Storage and retrieval**: Walrus supports storage operations to write and read blobs. It also diff --git a/docs/usage/examples.md b/docs/usage/examples.md index fa0e5d54..c337c727 100644 --- a/docs/usage/examples.md +++ b/docs/usage/examples.md @@ -2,7 +2,16 @@ As inspiration, we provide several simple examples in different programming languages to interact with Walrus through the various interfaces. They are located at -. + and described below. + +In addition, we have built actual applications on top of Walrus. The prime example is [Walrus +Sites](../walrus-sites/intro.md), with code available in the +[github.com/MystenLabs/walrus-sites](https://github.com/MystenLabs/walrus-sites) repository. + +And for an example of how to build a static website and store it as a Walrus Site with GitHub +actions, just look at the [CI +workflow](https://github.com/MystenLabs/walrus-docs/blob/main/.github/workflows/publish.yaml) we use +to publish this very site. ## Python diff --git a/docs/walrus-sites/intro.md b/docs/walrus-sites/intro.md index badc0830..730bf145 100644 --- a/docs/walrus-sites/intro.md +++ b/docs/walrus-sites/intro.md @@ -2,7 +2,9 @@ _Walrus Sites_ are "web"-sites that use Sui and Walrus as their underlying technology. They are a prime example of how Walrus can be used to build new and exciting decentralized applications. Anyone -can build and deploy a Walrus Site and make it accessible to the World! +can build and deploy a Walrus Site and make it accessible to the World! Funnily, this documentation +is itself available as a Walrus site at (if you +aren't there already). At a high level, the most exciting features include: