swadhin / opencodehub-docs public

- 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

swadhinbiswas committed 3 months ago
c606859
1 parent eeb5038
commit c606859
1 file changed
+60 -30
Showing 1 changed file+60-30
README.md
▼README.md
+60-30
@@ -1,49 +1,79 @@
1
-# Starlight Starter Kit: Basics
1
+# OpenCodeHub Documentation Site
2
2
3
-[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
3
+The official documentation for [OpenCodeHub](https://github.com/swadhinbiswas/OpencodeHub) — an open-source, self-hosted Git platform with Stacked PRs, AI Code Review, and Smart Merge Queues. Built with [Astro Starlight](https://starlight.astro.build) and deployed to [Cloudflare Workers](https://workers.cloudflare.com).
4
4
5
-```
6
-bun create astro@latest -- --template starlight
7
-```
8
-
9
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
10
-
11
-## 🚀 Project Structure
5
+**Live site:** <https://docs.opencodehub.space>
12
6
13
-Inside of your Astro + Starlight project, you'll see the following folders and files:
7
+## Project Structure
14
8
15
9
```
16
10
.
17
-├── public/
11
+├── public/ # Static assets (favicons, logos)
18
12
├── src/
19
-│ ├── assets/
13
+│ ├── assets/ # Logo variants (light/dark)
14
+│ ├── components/ # Custom Astro components (Hero overrides)
20
15
│ ├── content/
21
-│ │ └── docs/
22
-│ └── content.config.ts
23
-├── astro.config.mjs
16
+│ │ └── docs/ # Documentation pages (.md / .mdx)
17
+│ │ ├── getting-started/ # Installation & quick start guides
18
+│ │ ├── guides/ # Workflow & integration guides
19
+│ │ ├── features/ # Feature documentation (Stacked PRs, AI Review, etc.)
20
+│ │ ├── reference/ # CLI reference & glossary
21
+│ │ ├── administration/ # Deployment, config, security, monitoring
22
+│ │ ├── development/ # Architecture, contributing, testing
23
+│ │ ├── tutorials/ # Step-by-step tutorials
24
+│ │ └── api/ # REST API reference
25
+│ ├── content.config.ts # Starlight content config
26
+│ ├── custom.css # Custom theme overrides
27
+│ └── worker.ts # Cloudflare Workers static asset handler
28
+├── astro.config.mjs # Astro + Starlight configuration
29
+├── wrangler.jsonc # Cloudflare Workers deployment config
24
30
├── package.json
25
31
└── tsconfig.json
26
32
```
27
33
28
-Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
34
+Starlight looks for `.md` or `.mdx` files in `src/content/docs/`. Each file is exposed as a route based on its file name.
35
+
36
+Images go in `src/assets/` and are embedded in Markdown with relative links. Static assets like favicons go in `public/`.
37
+
38
+## Commands
39
+
40
+All commands run from the project root:
29
41
30
-Images can be added to `src/assets/` and embedded in Markdown with a relative link.
42
+| Command | Action |
43
+| :-------------------- | :------------------------------------------------ |
44
+| `bun install` | Install dependencies |
45
+| `bun dev` | Start local dev server at `localhost:4321` |
46
+| `bun build` | Build production site to `./dist/` |
47
+| `bun preview` | Preview the production build locally |
48
+| `bun deploy` | Deploy to Cloudflare Workers via Wrangler |
49
+| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
50
+| `bun astro -- --help` | Get help using the Astro CLI |
31
51
32
-Static assets, like favicons, can be placed in the `public/` directory.
52
+## Development
33
53
34
-## 🧞 Commands
54
+```bash
55
+# Install dependencies
56
+bun install
35
57
36
-All commands are run from the root of the project, from a terminal:
58
+# Start dev server
59
+bun dev
60
+```
61
+
62
+The dev server runs at `http://localhost:4321`. Edit files in `src/content/docs/` and the site hot-reloads.
63
+
64
+## Deployment
65
+
66
+This site is deployed to Cloudflare Workers. To deploy:
67
+
68
+```bash
69
+bun build
70
+bun deploy
71
+```
37
72
38
-| Command | Action |
39
-| :------------------------ | :----------------------------------------------- |
40
-| `bun install` | Installs dependencies |
41
-| `bun dev` | Starts local dev server at `localhost:4321` |
42
-| `bun build` | Build your production site to `./dist/` |
43
-| `bun preview` | Preview your build locally, before deploying |
44
-| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
45
-| `bun astro -- --help` | Get help using the Astro CLI |
73
+The `wrangler.jsonc` configures the worker to serve the static `dist/` directory. See [Cloudflare deployment guide](https://docs.opencodehub.space/administration/deploy-cloudflare/) for details.
46
74
47
-## 👀 Want to learn more?
75
+## Tech Stack
48
76
49
-Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
77
+- **Framework:** [Astro](https://astro.build) with [Starlight](https://starlight.astro.build) documentation theme
78
+- **Deployment:** [Cloudflare Workers](https://workers.cloudflare.com) (static assets)
79
+- **Package Manager:** [Bun](https://bun.sh)
50
80