Skip to content

README.md

Latest commit

 

History

History
101 lines (73 loc) · 4.59 KB

README.md

File metadata and controls

101 lines (73 loc) · 4.59 KB
Raw

Stratal Documentation

Built with Starlight Built with Astro License: MIT

The official documentation site for Stratal — a type-safe, modular framework purpose-built for Cloudflare Workers. Built with Astro and Starlight.

Live Site

stratal.dev

Overview

This repository contains the source for the Stratal documentation website. Stratal is a modular Cloudflare Workers framework featuring dependency injection, automatic OpenAPI documentation, queue consumers, cron jobs, and type-safe configuration.

If you're looking for the framework source code, see the strataljs/stratal repository.

Documentation Sections

  • Introduction — Why Stratal
  • Getting Started — Installation, first worker, project structure
  • OpenAPI Documentation — Setup, route conventions, schemas, Scalar UI
  • Core Concepts — Modules, controllers, dependency injection, providers, lifecycle hooks, configuration
  • Guides — Validation, guards, middleware, error handling, environment typing
  • Integrations — Queues, cron jobs, caching, storage, email, i18n, logging
  • Testing — Testing module, HTTP testing, mocks and fakes
  • API Reference — Auto-generated API docs

Local Development

Prerequisites

  • Node.js (v22 or later)
  • Yarn (v4 — included via Corepack)

Setup

git clone https://github.com/strataljs/docs.git
cd docs
yarn install
yarn dev

The dev server starts at http://localhost:4321.

Commands

Command Action
yarn install Install dependencies
yarn dev Start local dev server at localhost:4321
yarn build Build production site to ./dist/
yarn preview Preview production build locally
yarn astro ... Run Astro CLI commands (astro add, astro check)

Project Structure

├── public/                  # Static assets (favicon, images) served at root
├── src/
│   ├── assets/              # Processed assets (logo, images)
│   ├── content/
│   │   └── docs/            # Documentation pages (MDX/Markdown → URL routes)
│   │       ├── index.mdx    # Homepage (splash template)
│   │       ├── core-concepts/
│   │       ├── getting-started/
│   │       ├── guides/
│   │       ├── integrations/
│   │       ├── openapi/
│   │       └── testing/
│   └── styles/              # Custom CSS overrides
├── astro.config.mjs         # Astro + Starlight config (sidebar, plugins)
├── tsconfig.json            # TypeScript config (extends astro/tsconfigs/strict)
└── package.json

Documentation content lives in src/content/docs/. File paths map directly to URL routes (e.g., core-concepts/modules.md → /core-concepts/modules/).

Contributing

Contributions are welcome! Here's how to help improve the docs:

  1. Edit existing pages — Find the corresponding .md or .mdx file in src/content/docs/ and make your changes.
  2. Add new pages — Create a new Markdown or MDX file in the appropriate subdirectory. The file path determines the URL route.
  3. Update the sidebar — New pages need to be added to the sidebar array in astro.config.mjs to appear in navigation.
  4. File naming — Use kebab-case for file names (e.g., error-handling.md).

You can also edit any page directly on GitHub via the "Edit page" link at the bottom of each documentation page.

Tech Stack

  • Astro — Static site generator
  • Starlight — Documentation theme for Astro
  • Cloudflare Workers — Deployment adapter (@astrojs/cloudflare)
  • Mermaid — Diagrams in documentation (@pasqal-io/starlight-client-mermaid)

License

This project is licensed under the MIT License.