Skip to main content

Golden rules

  • Show complete commands that readers can copy/paste without guessing flags.
  • Label every fenced block with the language (bash, json, typescript, etc.).
  • Use realistic values (E.164 phones, Auth0-like IDs) so payloads feel real.
  • Provide both the request and the expected response for each flow.

Command snippets

Use fenced bash blocks for shell commands. Include the working directory when it matters.
For multi-platform instructions, list each platform explicitly so the reader can copy the relevant block:

HTTP requests

Document REST calls with <RequestExample> + <ResponseExample> so the API reference renders them side-by-side.

TypeScript excerpts

Point directly to real files so readers can jump into the repo. Keep snippets short and annotate anything that is non-obvious.
src/services/app/services/app-launch.service.ts
If the snippet spans multiple languages, use <CodeGroup> and include filenames so engineers know where to paste the code.