Skip to content

Commit 757e67b

Browse files
committed
update docs
1 parent f03bfb9 commit 757e67b

3 files changed

Lines changed: 42 additions & 1 deletion

File tree

content/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ Analyze PostgreSQL schemas and generate NoSQL (MongoDB) design and migration scr
2222
## Links
2323

2424
- [GitHub](https://github.com/usedamru/sql2nosql)
25+
- [Live docs](https://usedamru.github.io/sql2nosql/) (GitHub Pages)
2526
- Config: `sql2nosql.config.json` at project root

docs-site/README.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Damru — sql2nosql docs
2+
3+
Documentation site for **sql2nosql** (Damru). Built with VitePress; content lives in repo root `content/`.
4+
5+
## Develop
6+
7+
From repo root:
8+
9+
```bash
10+
yarn docs:dev
11+
```
12+
13+
Or from this folder:
14+
15+
```bash
16+
yarn install
17+
yarn dev
18+
```
19+
20+
Opens at `http://localhost:5173`.
21+
22+
## Build
23+
24+
```bash
25+
yarn docs:build
26+
```
27+
28+
Output: `docs-site/.vitepress/dist`.
29+
30+
## Deploy (GitHub Pages)
31+
32+
The workflow `.github/workflows/deploy-docs.yml` builds and deploys on every push to `main`.
33+
34+
**One-time setup:** Repo → **Settings****Pages****Source**: **GitHub Actions**.
35+
36+
Live site: **https://usedamru.github.io/sql2nosql/** (Damru / usedamru org).
37+
38+
## Content
39+
40+
Edit **repo root `content/*.md`** only. The site uses `srcDir: '../content'`—no duplication.

docs-site/content/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Content is in repo root
22

3-
The docs site reads markdown from **`content/`** at the **repo root** (one level above `docs-site/`).
3+
The **Damru** docs site reads markdown from **`content/`** at the repo root (one level above `docs-site/`).
44

55
Do not add `.md` files here. Edit `../content/*.md` instead so the docs and the site stay in sync.

0 commit comments

Comments
 (0)