ajzbc/docs

Stately docs for Stately Studio and XState

Welcome to the Stately docs

This repo contains the Stately landing page, including our blog and docs for Stately Studio and XState.

The site is built using Docusaurus 2.

We welcome any contributions to the documentation and code base.

• ✨ Contribution guide
• 🖊️ The Stately Guide to Writing Docs
• 🙋 Code of conduct

Installation

$ yarn

Local development

$ yarn dev

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

Note on the index page

Currently we serve the root landing page from a static file.

• During server side rendering (SSR) we use /static/index.html
• During client side rendering (CSR) we use /static/landing-page/index.html

Build

$ yarn build

This command generates static content into the build directory.

Deployment

The docs are built and deployed when merged into main.