swadhinbiswas 📝 docs: update README · 7/24/2026
a5fc437
57 lines · 2.1 KB
Raw Download

OpenCodeHub Documentation Site

The official documentation for OpenCodeHub — an open-source, self-hosted Git platform with Stacked PRs, AI Code Review, and Smart Merge Queues. Built with Astro Starlight and deployed to Cloudflare Workers.

Live site: https://docs.opencodehub.space

Project Structure

Starlight looks for .md or .mdx files in src/content/docs/. Each file is exposed as a route based on its file name.

Images go in src/assets/ and are embedded in Markdown with relative links. Static assets like favicons go in public/.

Commands

All commands run from the project root:

Command Action
bun install Install dependencies
bun dev Start local dev server at localhost:4321
bun build Build production site to ./dist/
bun preview Preview the production build locally
bun deploy Deploy to Cloudflare Workers via Wrangler
bun astro ... Run CLI commands like astro add, astro check
bun astro -- --help Get help using the Astro CLI

Development

# Install dependencies
bun install

# Start dev server
bun dev

The dev server runs at http://localhost:4321. Edit files in src/content/docs/ and the site hot-reloads.

Deployment

This site is deployed to Cloudflare Workers. To deploy:

bun build
bun deploy

The wrangler.jsonc configures the worker to serve the static dist/ directory. See Cloudflare deployment guide for details.

Tech Stack