Skip to content
Sicket Sicket Docs

Getting Started

Local development

Section titled “Local development”
Terminal window
pnpm install
pnpm dev

The docs site will start locally and expose:

  • docs pages through Astro Starlight
  • interactive API reference at /api-reference
  • raw OpenAPI spec at /openapi/openapi.yaml

Deployment target

Section titled “Deployment target”

This site is intended for:

  • https://docs.sicket.app

It is a static Astro site and can be hosted on a standard static hosting platform.

Initial maintenance rule

Section titled “Initial maintenance rule”

Whenever an API contract changes:

  1. update the OpenAPI spec
  2. update any affected docs pages
  3. note any integration caveats that are not obvious from OpenAPI alone