Skip to content

docs: add Starlight documentation site - #402

Merged
mvantellingen merged 1 commit into
mainfrom
docs/starlight-documentation-site
Jul 17, 2026
Merged

docs: add Starlight documentation site#402
mvantellingen merged 1 commit into
mainfrom
docs/starlight-documentation-site

Conversation

@mvantellingen

Copy link
Copy Markdown
Member

What

Adds a comprehensive documentation site under docs/, built with Astro Starlight and deployed to GitHub Pages.

Live URL once merged + Pages enabled: https://labd.github.io/commercetools-node-mock/

Contents

  • Getting started — introduction, installation, quick start (Vitest + msw), how it works
  • Configuration — options reference, authentication
  • Usage — seeding data (via the API), querying data, msw integration
  • Storage backends — overview, in-memory, SQLite, custom
  • Running as a server — standalone (runServer) + Docker
  • Recipes — Vitest setup, cart flow, custom types, fishery fixtures
  • Reference — API coverage & limitations, CommercetoolsMock, ProjectAPI, storage classes, errors
  • Homepage with install tabs (pnpm/npm/yarn) and a "Built by Lab Digital and Evolve" section with both logos

Notes

  • docs/ is a pnpm workspace package; the library's pnpm check is unaffected (docs/ is excluded in biome.json).
  • SEO/GEO output baked in: llms.txt / llms-full.txt, sitemap, and full-text search.
  • Content-based seeding is done through the APIunsafeAdd/getBaseResourceProperties are intentionally not documented (to be deprecated).

To go live after merge

  1. Repo Settings → Pages → Source: "GitHub Actions" (one-time).
  2. The docs workflow deploys automatically on pushes to main touching docs/**.

@changeset-bot

changeset-bot Bot commented Jul 17, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 98f3f8c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Adds a comprehensive documentation site under docs/, built with Astro
Starlight and deployed to GitHub Pages. Covers getting started, configuration,
usage, storage backends, running as a server, recipes and an API reference,
with an API coverage & limitations page.

- docs/ as a pnpm workspace package (excluded from biome via biome.json)
- GitHub Actions workflow to build and deploy to GitHub Pages
- README links to the site
- GEO/SEO output: llms.txt, sitemap and full-text search
@mvantellingen
mvantellingen force-pushed the docs/starlight-documentation-site branch from c08e055 to 98f3f8c Compare July 17, 2026 12:16
@mvantellingen
mvantellingen merged commit 6ff51ea into main Jul 17, 2026
15 checks passed
@mvantellingen
mvantellingen deleted the docs/starlight-documentation-site branch July 17, 2026 12:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant