swadhin / opencodehub public

📝 docs: update README

swadhinbiswas committed 3 months ago
a5fc437
1 parent de6ba86
commit a5fc437
1 file changed
+42 -35
Showing 1 changed file+42-35
docs-site/README.md
▼docs-site/README.md
+42-35
@@ -1,49 +1,56 @@
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
-```
5
+**Live site:** <https://docs.opencodehub.space>
8
6
9
-> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
7
+## Project Structure
10
8
11
-## 🚀 Project Structure
12
9
13
-Inside of your Astro + Starlight project, you'll see the following folders and files:
14
10
15
-```
16
-.
17
-├── public/
18
-├── src/
19
-│ ├── assets/
20
-│ ├── content/
21
-│ │ └── docs/
22
-│ └── content.config.ts
23
-├── astro.config.mjs
24
-├── package.json
25
-└── tsconfig.json
26
-```
11
+Starlight looks for `.md` or `.mdx` files in `src/content/docs/`. Each file is exposed as a route based on its file name.
12
+
13
+Images go in `src/assets/` and are embedded in Markdown with relative links. Static assets like favicons go in `public/`.
14
+
15
+## Commands
27
16
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.
17
+All commands run from the project root:
29
18
30
-Images can be added to `src/assets/` and embedded in Markdown with a relative link.
19
+| Command | Action |
20
+| :-------------------- | :------------------------------------------------ |
21
+| `bun install` | Install dependencies |
22
+| `bun dev` | Start local dev server at `localhost:4321` |
23
+| `bun build` | Build production site to `./dist/` |
24
+| `bun preview` | Preview the production build locally |
25
+| `bun deploy` | Deploy to Cloudflare Workers via Wrangler |
26
+| `bun astro ...` | Run CLI commands like `astro add`, `astro check` |
27
+| `bun astro -- --help` | Get help using the Astro CLI |
31
28
32
-Static assets, like favicons, can be placed in the `public/` directory.
29
+## Development
33
30
34
-## 🧞 Commands
31
+```bash
32
+# Install dependencies
33
+bun install
35
34
36
-All commands are run from the root of the project, from a terminal:
35
+# Start dev server
36
+bun dev
37
+```
38
+
39
+The dev server runs at `http://localhost:4321`. Edit files in `src/content/docs/` and the site hot-reloads.
40
+
41
+## Deployment
42
+
43
+This site is deployed to Cloudflare Workers. To deploy:
44
+
45
+```bash
46
+bun build
47
+bun deploy
48
+```
37
49
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 |
50
+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
51
47
-## 👀 Want to learn more?
52
+## Tech Stack
48
53
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).
54
+- **Framework:** [Astro](https://astro.build) with [Starlight](https://starlight.astro.build) documentation theme
55
+- **Deployment:** [Cloudflare Workers](https://workers.cloudflare.com) (static assets)
56
+- **Package Manager:** [Bun](https://bun.sh)
50
57