Skip to content
Docs-as-Code Primer
Esc
navigateopen⌘Jpreview
On this page

Getting started with [Product name]

> A getting-started guide is the shortest path from zero to first value. If it takes longer than [N] minutes, it's a tutorial or a setup reference, not a getting-started.

Getting started with [Product name]

A getting-started guide is the shortest path from zero to first value. If it takes longer than [N] minutes, it’s a tutorial or a setup reference, not a getting-started.

Prerequisites

  • An account / API key
  • [Tool / SDK version requirement]
  • [Any paid plan or enabled feature]

Quick start

1. Install / authenticate

# Single command to get running
npm install @org/sdk
# or
brew install org-cli

2. Do the first thing

# The shortest possible workflow

3. Verify it worked

Expected output or confirmation page shown

Next steps

Troubleshooting

Problem Likely cause Fix

Was this page helpful?