• Basic documentation
• Basic CI workflows
• Linting configuration
• Pre-commit hooks
• Dependabot
• Recommended IDE addons?

0x7954ae683314ec7e156acbf0c0fc964ce035fd7f456fe7576848226502cfde1b::direct_setup::set_target_address

This is supported based on https://github.com/tommilligan/mdbook-admonish.

There are two TODO in the python example comments, about how one configures walrus to run them.

We may want/have to wipe Walrus at times, for example to re-deploy changed contracts. This requires re-publishing all the example Walrus Sites that we have (list may be incomplete):

• docs (docs.walrus.site)
• snake (walrusgame.walrus.site)
• flatlander (flatlander.walrus.site)
• publisher (publisher.walrus.site)
• redirects (blog.walrus.site, legal.walrus.site)
• binaries (bin.walrus.site)

• Add a link checker and potentially other lints
• Add workflow to publish commits on main
• Add workflow creating previews for PRs
• Make sure jobs only run when necessary (relevant files changed)

Some concepts would be easier to understand with visual support:

• How all ecosystem components fit together and interact
• How blobs, slivers, shards, and storage nodes are related

Suggested in #106

• Client CLI, JSON mode, and daemon -> #16
• General developer guide (@gdanezis) -> #18
• Installation and configuration instructions (@mlegner) -> #21
• Walrus sites (@giac-mysten) -> #19
• Public aggregator and publisher (@mlegner) -> #30

Also add a redirect from blog.walrus.site to docs.walrus.site/blog (or wherever the blog post will be located).

These can then also be set as the default in the JavaScript example.

When #21 is merged

See comment

Additional tasks:

• Remove deploy key in walrus-sites
• Remove SSH-key secret
• Change CI job to publish Walrus Site to use HTTPS

After the documentation is complete, we should do a complete pass to make sure we are consistent, internal references make sense, and all the information is up-to-date.

This includes the following:

• make sure all terms are introduced the first time they are used
• make sure we correctly introduce and use the terms aggregator and cache
• use terms "read"<->"download" and "upload"<->"store" consistently
• consistent capitalization of terms and titles
• consistent use of American English
• consistent and correct use of math mode
• Oxford comma

We can also add some additional markdownlint rules, for example on word capitalization.

Contributes to #23

Specifically, make sure that the instructions install the binary to $PATH, and config to ~/.walrus/config

All of them should be self-contained and testable in CI.

• Python -> #9
• TypeScript -> #20

This is the last step of the Devnet milestone.

• #26.
• Remove exception from the mdBook linkchecker (https://github.com/MystenLabs/walrus-docs/blob/main/book.toml#L18).
• Update latest client binaries.
• Change the repository's visibility.

We should make sure that any examples we keep in this repository are compatible with the latest Walrus deployment.

The job could consist of the following steps:

1. Install sui
2. Create a testnet address and get SUI from the faucet
3. Get the latest Walrus binary and config from the GCS bucket
4. Depending on the example, run the binary in daemon mode
5. Run the example and ensure it succeeds

Currently deployed sites:

• Docs: https://docs.walrus.site
• Blog redirect: https://blog.walrus.site
• Compiled Walrus binaries: https://bin.walrus.site
• Publish blobs page (public version of JS example): https://publish.walrus.site/
• Image gallery: https://gallery.walrus.site/
• Walrus dApp example that calls Sui logic to mint NFTs: https://flatland.walrus.site/
• Site tracking data stored on Walrus: https://capacity.walrus.site/
• Hackathon: https://breakingtheice.walrus.site
• Additional Walrus Examples by Community (not updated after redeployment):
  • https://polymedia.walrus.site/
  • https://suidappstarter.walrus.site/

• Avoid confusion with example value in configuration file docs.
• Store configuration file directly in the standard location.
• Make standard steps more prominent than advanced example (swap the order and emphasize that other parameters are optional).

Target should be https://docs.walrus.site/blog/00_intro.html.