Skip to content

Commit ea0b746

Browse files
feat: add complete documentation system with GitHub Pages deployment
1 parent 33a9040 commit ea0b746

33 files changed

+12082
-2
lines changed

.cursorrules

Lines changed: 514 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2+
name: Deployment Help
3+
about: Get help with deploying to GitHub Pages
4+
title: "[DEPLOYMENT] "
5+
labels: ["deployment", "help wanted"]
6+
assignees: []
7+
---
8+
9+
## Deployment Issue
10+
11+
**Describe the issue you're experiencing with deployment:**
12+
13+
### Expected Behavior
14+
What should happen when you deploy?
15+
16+
### Actual Behavior
17+
What is actually happening?
18+
19+
### Steps to Reproduce
20+
1.
21+
2.
22+
3.
23+
24+
### Environment
25+
- **Repository URL**:
26+
- **Branch**:
27+
- **GitHub Actions Run**:
28+
- **Error Messages**:
29+
30+
### Additional Information
31+
- Screenshots of the issue
32+
- Links to relevant documentation
33+
- Any error logs from GitHub Actions
34+
35+
### Checklist
36+
- [ ] I've read the [DEPLOYMENT.md](../DEPLOYMENT.md) guide
37+
- [ ] I've enabled GitHub Pages in repository settings
38+
- [ ] I've configured GitHub Actions permissions
39+
- [ ] I've checked the Actions tab for build errors
40+
- [ ] I've verified the `out` directory is generated
41+
42+
### What I've Tried
43+
- [ ] Running `npm run build` locally
44+
- [ ] Checking GitHub Actions logs
45+
- [ ] Verifying repository settings
46+
- [ ] Testing with a simple change
47+
48+
---
49+
50+
**Additional Context:**
51+
Add any other context about the problem here.

.github/workflows/deploy.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Deploy to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
build:
21+
runs-on: ubuntu-latest
22+
steps:
23+
- name: Checkout
24+
uses: actions/checkout@v4
25+
26+
- name: Setup Node.js
27+
uses: actions/setup-node@v4
28+
with:
29+
node-version: '18'
30+
cache: 'npm'
31+
32+
- name: Install dependencies
33+
run: npm ci
34+
35+
- name: Run linting
36+
run: npm run lint
37+
38+
- name: Run type checking
39+
run: npm run type-check
40+
41+
- name: Run tests
42+
run: npm run test:unit
43+
44+
- name: Build application
45+
run: npm run build
46+
env:
47+
NODE_ENV: production
48+
49+
- name: Setup Pages
50+
uses: actions/configure-pages@v4
51+
52+
- name: Upload artifact
53+
uses: actions/upload-pages-artifact@v3
54+
with:
55+
path: ./out
56+
57+
deploy:
58+
runs-on: ubuntu-latest
59+
needs: build
60+
if: github.ref == 'refs/heads/main'
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)