MystenLabs

walrus-docs: Document Walrus Decentralized Blob Storage

Walrus Docs is the original documentation and examples repository for Walrus, a decentralized storage and availability protocol for large binary files. It is archived; the documentation has moved to the Walrus repository.

Stars
652
Forks
166
Stars, last 30 days
-2
Last commit
1.3 years ago
Contributors
62

Our take

Archivedarchived by its owners on GitHub, read-only

Health score

34/100

How it is scored
Activity
19
Community
76
Issues
21
Pull requests
20

-2 stars in the last 30 days

This is useful as a historical reference for Walrus, but its archived status makes the current Walrus repository the right place to start for active work.

Good fit if

  • You need historical documentation or examples about Walrus's decentralized blob storage approach.
  • You want to inspect how the original documentation was authored with mdBook and translated.

Look elsewhere if

  • You need current guidance, want to report an issue, or plan to contribute, since this repository is read-only and points to the Walrus repository.
  • You need an actively maintained documentation source, as this repository has no recent commits or releases.
All health signals
Last commit2025-07-08 (1.3 years ago)
Commits, last 90 days0
Releases, last 12 months0
Contributors62 (top contributor: 35% of commits)
Issues closed, last 90 days0
Pull requests merged, last 90 days0
Project age2 years

Checked on 2026-10-16 with the GitHub API.

Project history

Daily GitHub snapshots since Oct 7, 2026. History covers stars and forks; health signals are not tracked historically.

Selected snapshot

Stars

650

Forks

165

Change since Nov 17, 2026: 0 stars·0 forks

Overview

Walrus is a decentralized storage and availability protocol designed for large binary files, or blobs. This repository contains the original documentation and examples, explaining the system and how to work with it. Walrus is intended for storing unstructured content across decentralized storage nodes while maintaining availability in the presence of Byzantine faults.

This repository is archived and read-only. The project directs users to the Walrus repository for current documentation, contributions, and issue reports. The published documentation is available at docs.walrus.site, with the original material built from Markdown files using mdBook.

Key Features

  • Documentation for Walrus's decentralized blob storage and availability protocol.
  • Examples and guidance for working with unstructured binary content.
  • Describes storage across decentralized nodes and availability despite Byzantine faults.
  • Builds documentation from the docs/ directory with mdBook.
  • Includes translation support through files in po/ and the MDBOOK_BOOK__LANGUAGE environment variable.
  • Publishes documentation as a Walrus Site and on GitHub Pages.

Use Cases

  • Developers evaluating Walrus for storing large unstructured files can use the documentation to understand the protocol's purpose and capabilities.
  • Teams already using Walrus can consult the published docs for usage guidance, while directing new questions and changes to the current repository.
  • Documentation contributors can use the archived source as historical reference when checking older guidance or translations.

What you need

Detected in the repository

  • Move (main language on GitHub)
  • Automated checks on GitHub Actions

License in plain words

Apache-2.0permissive

  • Commercial use: yes
  • Modify and redistribute: yes
  • You must keep: the license, the NOTICE file and a note of your changes
  • Share your changes: no
  • Includes an explicit patent grant from the contributors:

A summary, not legal advice: the LICENSE file is what applies.

Getting Started

Read the published documentation at docs.walrus.site. For current documentation and project activity, use the Walrus repository. To build this archived source locally, install mdBook and its documented plugins, then run mdbook serve. See the README and TRANSLATING.md for details.

Considerations

The repository is archived and read-only, with no recent commits or releases, so its content may not reflect the current Walrus project. The README explicitly directs issue reports and contributions to the main Walrus repository. Local documentation builds require Rust and mdBook, along with the listed mdBook plugins. The source is licensed under Apache-2.0; review that license when reusing its content.

Found this useful?

Share it with someone who would like walrus-docs.