swadhin / opencodehub-docs public
/ opencodehub-docs / README.md
swadhinbiswas - Title & description: Now correctly identifies this as the OpenCodeHub documentation site, not a Starlight template - Live site link: Added the actual URL (docs.opencodehub.space) - Project structure: Updated to match the real directory layout - Commands: Added the bun deploy command - Development section: Added a quick-start snippet - Deployment section: Documented the Cloudflare Workers deployment workflow - Tech stack: Listed Astro + Starlight, Cloudflare Workers, and Bun - Removed: The emoji headers, "Seasoned astronaut" joke, and Starlight boilerplate links · 7/21/2026
c606859
80 lines · 3.6 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

.
├── public/                          # Static assets (favicons, logos)
├── src/
│   ├── assets/                      # Logo variants (light/dark)
│   ├── components/                  # Custom Astro components (Hero overrides)
│   ├── content/
│   │   └── docs/                    # Documentation pages (.md / .mdx)
│   │       ├── getting-started/     # Installation & quick start guides
│   │       ├── guides/              # Workflow & integration guides
│   │       ├── features/            # Feature documentation (Stacked PRs, AI Review, etc.)
│   │       ├── reference/           # CLI reference & glossary
│   │       ├── administration/      # Deployment, config, security, monitoring
│   │       ├── development/         # Architecture, contributing, testing
│   │       ├── tutorials/           # Step-by-step tutorials
│   │       └── api/                 # REST API reference
│   ├── content.config.ts            # Starlight content config
│   ├── custom.css                   # Custom theme overrides
│   └── worker.ts                    # Cloudflare Workers static asset handler
├── astro.config.mjs                 # Astro + Starlight configuration
├── wrangler.jsonc                   # Cloudflare Workers deployment config
├── package.json
└── tsconfig.json

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