Configuration · Specistry Docs

Objects are strict: unknown keys fail. Paths are project-relative and must remain under the project root after symlink resolution.

Field	Default	Purpose
`schemaVersion`	required	Currently `1`
`name`	required	1–120 characters
`openapi`	[]	One path or an array — one service each
`docs`	./docs	Authored content directory
`branding`	—	`accent`, `logo`, `favicon`
`navigation`	pages, then API	Sections, pages, API position, links
`environments`	`{}`	Named base URLs for examples
`sdks`	[]	Explicit SDK examples
`playground`	disabled	Browser-direct execution
`quality`	failOn: error	Severities, thresholds, suppressions

specistry.config.ts

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

export default defineConfig({
  schemaVersion: 1,
  name: "TestInbox",
  openapi: "./openapi.yaml",
  docs: "./docs",
  branding: { accent: "#297bf3", logo: "./assets/logo.svg" },
  navigation: [
    "quickstart",
    { section: "Guides", items: ["guides/webhooks"] },
    { api: true, label: "API reference" },
  ],
  environments: {
    sandbox: { baseUrl: "https://sandbox.testinbox.email" },
  },
  playground: { mode: "browser", environments: ["sandbox"] },
  quality: { failOn: "warning", maxWarnings: 0 },
});