Template · API + guides · Specistry Docs

specistry.config.ts

import { defineConfig } from "@specistry/config";

export default defineConfig({
  schemaVersion: 1,
  name: "TestInbox",
  openapi: "./openapi.yaml",
  branding: { logo: "./assets/logo.svg", accent: "#7c3aed" },
  navigation: [
    "quickstart",
    "authentication",
    { section: "Guides", items: ["guides/waiting-for-messages"] },
    { api: true, label: "API reference" },
  ],
  environments: {
    sandbox: { label: "Sandbox", baseUrl: "https://sandbox.testinbox.email" },
  },
  playground: { mode: "browser", environments: ["sandbox"] },
});

docs/quickstart.mdx

---
title: Quickstart
description: Your first test email in five minutes.
---

<Steps>

<Step title="Create an inbox">

Call [Create inbox](/api/inboxes/create-inbox).

</Step>

<Step title="Wait for the email">

```typescript title="signup.test.ts"
const msg = await inbox.messages.wait({ timeout: 30_000 });
```

</Step>

</Steps>