Termly Public API Documentation

Source for the public Termly API documentation, published at docs.termly.io.

This is the partner-facing reference for the Termly Public API — authentication, request signing, and every supported endpoint. It is a Starlight site built with Astro.

src/
├── assets/               # logo and images
├── content/
│   └── docs/
│       ├── index.mdx     # landing page
│       ├── introduction/ # authentication, making a request
│       ├── quickstart/   # worked examples
│       ├── endpoints/    # one page per endpoint + verb
│       └── other/        # signature, query, paging, error objects
└── content.config.ts
astro.config.mjs          # site config and sidebar

Every .md / .mdx file under src/content/docs/ becomes a route based on its path — src/content/docs/endpoints/websites-get.md is served at /endpoints/websites-get/.

Requires Node.js 20+.

npm install
npm run dev      # http://localhost:4321

npm run check runs the same checks as CI, so run it before opening a PR. Link checking uses lychee, which is a separate binary:

brew install lychee

Its settings live in lychee.toml and are shared with CI. External link checks occasionally fail on a dropped connection — re-run before assuming a link is dead.

1. Add a .md file in the appropriate src/content/docs/ subdirectory.

2. Give it frontmatter with a title and description:

   ---
   title: Websites
   description: A guide on how to use the Websites endpoint
   ---

3. Add it to the sidebar array in astro.config.mjs — pages are not picked up automatically. Use the slug without the src/content/docs/ prefix or file extension, e.g. endpoints/websites-get.

4. Run npm run build before opening a PR. The build catches broken internal links and invalid frontmatter.

Merges to main publish automatically to docs.termly.io via GitHub Pages, using the Deploy Astro site to Pages workflow in .github/workflows/astro.yaml.

Pull requests get a build check (.github/workflows/ci.yml) but no preview deployment — GitHub Pages only serves main. To see rendered changes, run npm run dev locally.

Termly staff: the Pages setup, DNS, and rollback procedure are documented in the Public API Docs — hosting runbook in Slite.

The documentation must describe the API as it actually behaves. When an endpoint changes, update these docs in the same cycle — partners integrate directly against what is published here.