Asynkron Documentation

This repository hosts the Docusaurus configuration and content used to publish the official Asynkron documentation site.

docs/products (product overview and Products), docs/ProtoActor, and docs/DurableFunctions are the public documentation sources ingested by Docusaurus, each served as its own dedicated section with its own sidebar.

The other content under docs—including dreaming.md, product, adrs, and journal—is internal Faktorial and documentation-platform working material and is not published on the documentation site.

• Node.js 20 or newer (the project follows the Docusaurus v3 requirements).

Install the project dependencies once after cloning the repository:

npm ci

This installs the dependency versions committed in package-lock.json for a reproducible local environment.

npm run start

This starts the hot-reloading development server at http://localhost:3000. Updating Markdown, MDX, or React files refreshes the browser automatically so you can iterate quickly.

npm run build

The build command emits the static production site into the build/ directory. You can deploy the generated assets to any static host.

The project keeps the default Docusaurus GitHub Pages workflow. After setting the organizationName and projectName values in docusaurus.config.ts, you can deploy with:

npm run deploy

The script builds the site and publishes it to the gh-pages branch of the configured GitHub repository.