Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

Local Development

$ yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.

Partials

.mdx files beginning with a _ character are partials. These are useful for including a piece of content in multiple locations, such as tables of annotations that can be inserted both in their relevant section, as well as stored in a single reference location.

Dead Links

If you delete a page you should create a redirect for it so that it doesn't break links. This configuration is located in the docusaurus config

AI Citation Readiness Checklist

Use this checklist when adding or updating docs pages:

• Start with a plain-language definition of what the feature does.
• State who should use it and when to use it.
• Keep terminology consistent with canonical terms (Speedscale, proxymock, snapshot, replay, transform).
• Use clear headings and short sections that can be quoted out of context.
• Prefer decision/comparison tables for "which option should I choose" content.
• Align product descriptions with speedscale.com and llms.txt wording.

Public Writing Checks

Follow the repository public-writing rules and run yarn check:writing before pushing documentation changes. It checks added public prose by default, while yarn check:writing --all reports the existing backlog. The same checker runs in pull request and main-branch CI.