Sample demo

This page is a filled-in example of the house style. Read it to see the shape of a good demo page, then start your own from the demo template.

What this demonstrates

One short paragraph on the point of the demo, written for someone deciding whether it is worth their next fifteen minutes. Lead with the capability being shown, not the technology stack. A reader should be able to tell from this section alone whether to keep reading.

Audience: internal engineers evaluating the deployment workflow. Runtime: about 10 minutes end to end.

Before you start

• Access to the staging environment
• Node.js 20 or newer installed locally
• The demo-cli tool authenticated against your account

Note

If a prerequisite needs a request that takes days to fulfil, say so here explicitly. Nothing wastes more time than discovering a blocking approval at step four.

Running it

1. Clone the demo repository and install dependencies.

   git clone https://github.com/your-org/sample-demo.git
   cd sample-demo
   npm install

2. Start the demo against the staging environment.

   npm run demo -- --env staging

3. Open http://localhost:3000 and sign in with your staging credentials.

4. Trigger the workflow from the dashboard and watch the job move through the queue.

What to look for

Call out the specific moments that make the demo land, because they are easy to miss on a first run. For example: the job is picked up in under a second, and the retry happens automatically when you kill the worker mid-run.

Known issues

Symptom	Cause	Workaround
Job stays queued	Stale worker registration	Restart with npm run demo:reset
Sign-in loop	Expired staging token	Re-authenticate with demo-cli login

Ownership

• Owner: add name
• Last verified against: add version or date
• Source: add repository link