t3-code-android-nightly/.repos/alchemy-effect/website/README.md

39 lines
1.2 KiB
Markdown

# Alchemy Effect Website
This workspace contains the customer-facing docs site for Alchemy Effect.
## Build Pipeline
The site is intentionally split into independent steps:
1. `pnpm build:reference` generates Zola-compatible API reference pages from the TypeScript source tree.
2. `pnpm build:assets` compiles the shared Tailwind CSS and the custom browser JavaScript bundle.
3. `pnpm build:site` renders the site with Zola.
4. `pnpm build:search` indexes the built HTML with Pagefind.
5. `alchemy.run.ts` deploys the final `dist/` directory through `Cloudflare.Website.StaticSite(...)`.
This keeps the large markdown corpus on a Rust-first rendering path while still
allowing a modern custom UI.
## Local Commands
- `pnpm build`
- `pnpm dev:site`
- `pnpm deploy`
- `pnpm destroy`
## Benchmark Snapshot
Measured locally on 2026-04-02:
- API reference generation: about `2.2s`
- Tailwind + browser bundle build: about `0.9s`
- Zola render: about `0.6s`
- Pagefind indexing: about `0.3s`
- Total built files in `dist/`: `693`
- Total built bytes in `dist/`: `3,120,670`
- Pagefind files: `350`
- Pagefind bytes: `633,383`
These numbers should be treated as a baseline for future changes to the docs
pipeline.