Skip to content

Commit d4e78bf

Browse files
authored
Merge pull request #56 from pchalasani/docs/starlight
Add Starlight documentation site (32 pages)
2 parents cc287a8 + 3036792 commit d4e78bf

64 files changed

Lines changed: 10919 additions & 1219 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/deploy-docs.yml

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Deploy Docs to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "docs-site/**"
8+
- ".github/workflows/deploy-docs.yml"
9+
workflow_dispatch:
10+
11+
permissions:
12+
contents: read
13+
pages: write
14+
id-token: write
15+
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
build:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
27+
- name: Setup Node
28+
uses: actions/setup-node@v4
29+
with:
30+
node-version: 20
31+
cache: npm
32+
cache-dependency-path: docs-site/package-lock.json
33+
34+
- name: Install dependencies
35+
run: npm ci
36+
working-directory: docs-site
37+
38+
- name: Build
39+
run: npm run build
40+
working-directory: docs-site
41+
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: docs-site/dist
46+
47+
deploy:
48+
environment:
49+
name: github-pages
50+
url: ${{ steps.deployment.outputs.page_url }}
51+
runs-on: ubuntu-latest
52+
needs: build
53+
steps:
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ hooks/settings.json
175175
.env*
176176
node_modules/
177177
package-lock.json
178+
!docs-site/package-lock.json
178179

179180
# Backup files
180181
*.backup*

Makefile

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: install release patch minor major dev-install help clean all-patch all-minor all-major release-github lmsh lmsh-install lmsh-publish aichat-search aichat-search-install aichat-search-release aichat-search-patch aichat-search-minor aichat-search-major aichat-search-publish fix-session-metadata fix-session-metadata-apply delete-helper-sessions delete-helper-sessions-apply prep-node update-homebrew
1+
.PHONY: install release patch minor major dev-install help clean all-patch all-minor all-major release-github lmsh lmsh-install lmsh-publish aichat-search aichat-search-install aichat-search-release aichat-search-patch aichat-search-minor aichat-search-major aichat-search-publish fix-session-metadata fix-session-metadata-apply delete-helper-sessions delete-helper-sessions-apply prep-node update-homebrew docs-dev docs-build docs-preview
22

33
help:
44
@echo "Available commands:"
@@ -245,3 +245,16 @@ update-homebrew:
245245
exit 1; \
246246
fi
247247
@./scripts/update-homebrew-formula.sh $(VERSION)
248+
249+
docs-dev:
250+
@echo "Starting docs dev server..."
251+
@cd docs-site && npm run dev
252+
253+
docs-build:
254+
@echo "Building docs..."
255+
@cd docs-site && npm run build
256+
@echo "Docs built to docs-site/dist/"
257+
258+
docs-preview:
259+
@echo "Previewing docs..."
260+
@cd docs-site && npm run preview

0 commit comments

Comments
 (0)