Skip to content

Documentation guide

How this site is organised and the conventions it uses.

Layout

The left sidebar lists the top-level sections; click any to expand. The right sidebar shows the table of contents for the page you're on. The header search box (top right) is full-content — it indexes every page including code blocks and admonitions.

Sections

Section What it's for
Home One-screen overview, deploy summary, links into the rest of the site
Get started Install walkthrough — prerequisites, the TUI flow, post-deploy actions, hardware setup
Console Tour of every page in the Web Console, with screenshots
CLI The wsctl command-line tool, the wsctl.json reference, and the command listing
Concepts How Waveshift works — control plane / data plane, architecture, AWS infrastructure
Key questions One-diagram answers to the questions customers ask most often
Reference Defaults, glossary, FAQ, common issues, upgrading, brand assets, this guide

Visual conventions

Admonition boxes

Coloured callout boxes flag the type of content. Read them in this order if a page has several:

Box Meaning
Danger (red) Destructive or irreversible operation. Read before you do the thing.
Warning (orange) Prerequisite or caveat that affects whether the next step works.
Tip (green) Best practice or shortcut. Helpful but skippable.
Info / Note (blue) Context, references, or non-critical detail.
Example (purple) Worked example or full command sequence.

The full taxonomy lives in Material's admonition reference; this site uses the standard set without overrides.

Collapsible sections

Lines that start with ??? (chevron in the rendered page) are collapsed by default. Click them to expand. The FAQ and Common issues pages are question-per-collapsible by design.

Light + dark screenshots

Most screenshots in the Console tour ship in two variants — Material swaps which one is shown based on the page colour scheme (toggle the sun/moon icon in the header to see the other).

Tabbed code blocks

When instructions differ per platform, you'll see tabs across the top of the code block:

brew install awscli

sudo apt-get install -y awscli

choco install awscli

Click whichever applies.

The search box (top right) is the fastest way to land on a specific term. It indexes every page, code block, and admonition. Useful queries:

  • a specific command or flag (e.g. node-site)
  • a screen name from the Console (e.g. Egress Servers)
  • an error string copied from a log

Reporting issues with the docs

If something here is wrong, missing, or out of date, contact Blackfire — these docs are private and the audience already knows who to ask.

See also