Skip to content

Commit c5242a1

Browse files
tac0turtletac0turtle
andauthored
fix: docs deployment (#2528)
<!-- Please read and fill out this form before submitting your PR. Please make sure you have reviewed our contributors guide before submitting your first PR. NOTE: PR titles should follow semantic commits: https://www.conventionalcommits.org/en/v1.0.0/ --> ## Overview <!-- Please provide an explanation of the PR, including the appropriate context, background, goal, and rationale. If there is an issue with this information, please provide a tl;dr and link the issue. Ex: Closes #<issue number> --> --------- Co-authored-by: tac0turtle <[email protected]>
1 parent 70c6813 commit c5242a1

File tree

5 files changed

+17
-8
lines changed

5 files changed

+17
-8
lines changed

.github/workflows/build_docs.yml renamed to .github/workflows/docs_build.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ on:
66
push:
77
branches: [main]
88
paths:
9-
- "./docs"
9+
- "docs/**"
1010
pull_request:
1111
paths:
12-
- "./docs"
12+
- "docs/**"
1313

1414
jobs:
1515
build:
@@ -22,7 +22,10 @@ jobs:
2222
with:
2323
node-version: 20
2424
cache: yarn # or pnpm / npm
25+
cache-dependency-path: docs/yarn.lock
2526
- name: Install dependencies
2627
run: yarn install # or pnpm install / npm ci
28+
working-directory: docs
2729
- name: Build with VitePress
2830
run: yarn build # or pnpm build / npm build
31+
working-directory: docs

.github/workflows/deploy_docs.yml renamed to .github/workflows/docs_deploy.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
push:
99
branches: [main]
1010
paths:
11-
- "./docs"
11+
- "docs/**"
1212

1313
# Allows you to run this workflow manually from the Actions tab
1414
workflow_dispatch:
@@ -37,15 +37,18 @@ jobs:
3737
with:
3838
node-version: 20
3939
cache: yarn # or pnpm / npm
40+
cache-dependency-path: docs/yarn.lock
4041
- name: Setup Pages
4142
uses: actions/configure-pages@v5
4243
- name: Install dependencies
4344
run: yarn install # or pnpm install / npm ci
45+
working-directory: docs
4446
- name: Build with VitePress
4547
run: yarn build # or pnpm build / npm build
48+
working-directory: docs
4649
- name: Deploy to GitHub Pages
4750
uses: peaceiris/actions-gh-pages@v4
4851
with:
4952
github_token: ${{ secrets.GITHUB_TOKEN }}
50-
publish_dir: ./.vitepress/dist
53+
publish_dir: ./docs/.vitepress/dist
5154
cname: ev.xyz

.github/workflows/preview_docs.yml renamed to .github/workflows/docs_preview.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010
- synchronize
1111
- closed
1212
paths:
13-
- "./docs"
13+
- "docs/**"
1414

1515
concurrency: preview-${{ github.ref }}
1616

@@ -28,17 +28,20 @@ jobs:
2828
with:
2929
node-version: 20
3030
cache: yarn
31+
cache-dependency-path: docs/yarn.lock
3132

3233
- name: Install dependencies
3334
run: yarn install --frozen-lockfile
35+
working-directory: docs
3436

3537
- name: Build with Base URL
3638
run: BASE='/docs-preview/pr-${{ github.event.number }}/' yarn build
39+
working-directory: docs
3740

3841
- name: Deploy preview
3942
uses: rossjrw/pr-preview-action@v1
4043
with:
41-
source-dir: .vitepress/dist
44+
source-dir: docs/.vitepress/dist
4245
deploy-repository: evstack/docs-preview
4346
token: ${{ secrets.PREVIEW_DEPLOY }}
4447
preview-branch: main

docs/CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This is a **VitePress-based documentation site** for Evolve. Key architectural e
2323

2424
### Content Organization
2525

26-
```
26+
```txt
2727
docs/
2828
├── .vitepress/config.ts # Site configuration, navigation, theme
2929
├── blog/ # Blog posts and announcements

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[![Deploy](https://github.com/evstack/ev-node/actions/workflows/deploy.yml/badge.svg)](https://github.com/evstack/docs/actions/workflows/deploy.yml)
1+
[![Deploy](https://github.com/evstack/ev-node/actions/workflows/deploy.yml/badge.svg)](https://github.com/evstack/ev-node/actions/workflows/deploy.yml)
22

33
# Evolve Documentation Site
44

0 commit comments

Comments
 (0)