Skip to content

Latest commit

 

History

History
62 lines (46 loc) · 2.48 KB

File metadata and controls

62 lines (46 loc) · 2.48 KB

Durable Workflow Documentation

Documentation Qualification Deploy to GitHub Pages License: MIT

This repository contains the source for durable-workflow.com, including the current Durable Workflow 2.0 documentation, the versioned 1.x documentation, the blog, and public protocol references.

Local development

Use Node.js 24 and npm:

npm ci
npm run start

Build the same static site and validate the same links as CI:

npm run build

Ukrainian translations

English is the default locale. Current documentation and site pages are also available in Ukrainian under /uk/. Preview that locale with:

npm run start -- --locale uk

Translate current docs in i18n/uk/docusaurus-plugin-content-docs/current/ and standalone pages in i18n/uk/docusaurus-plugin-content-pages/. Keep the English source file paths, examples, commands, API names and explicit heading anchors intact. Keep workflow, activity, worker, signal, timer, query, update and saga as English technical terms.

Use Docusaurus translation markers for component text. Run npm run write-translations -- --locale uk to extract new messages, then translate them in i18n/uk/code.json and the plugin message files. Build both locales with npm run build before submitting a change. Blog articles and the versioned 1.x docs use the English fallback.

Repository layout

Path Purpose
docs/ Current 2.0 documentation
versioned_docs/ Maintained 1.x documentation snapshot
blog/ Durable Workflow articles
src/ Docusaurus pages, components, theme overrides, and styling
static/ Public images, installers, and machine-readable protocol artifacts

Pushes to main deploy through GitHub Pages after the documentation build passes. Protocol contracts have a separate focused validation workflow.

See the organization contribution guide before opening a pull request.