Skip to content

Commit

Permalink
docs: add some self-referential pointers (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
mlegner authored Jun 14, 2024
1 parent 097c2ad commit 8a50be6
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 7 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand Down
5 changes: 3 additions & 2 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ follow-web-links = true
warning-policy = "error"
# TODO: Remove these after making the repositories public (#32).
exclude = [
'github\.com/MystenLabs/walrus-docs', # Currently still private
'github\.com/MystenLabs/walrus-sites', # Currently still private
'github\.com/MystenLabs/walrus-docs', # Currently still private.
'github\.com/MystenLabs/walrus-sites', # Currently still private.
'walrus\.site', # No service worker in the link checker.
]
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.walrus.site>, 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
Expand Down
11 changes: 10 additions & 1 deletion docs/usage/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/MystenLabs/walrus-docs/tree/main/examples>.
<https://github.com/MystenLabs/walrus-docs/tree/main/examples> 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

Expand Down
4 changes: 3 additions & 1 deletion docs/walrus-sites/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.walrus.site/walrus-sites/intro.html> (if you
aren't there already).

At a high level, the most exciting features include:

Expand Down

0 comments on commit 8a50be6

Please sign in to comment.