Skip to content

Commit 38a0fff

Browse files
authored
Add static Vibe-Trading wiki
Add a static Cloudflare Pages wiki under wiki/, including the landing page, docs app, redirects/headers, maintainer README, and wiki validation workflow.
1 parent f85f3b8 commit 38a0fff

20 files changed

Lines changed: 1999 additions & 0 deletions

.github/workflows/wiki.yml

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: Wiki
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- "wiki/**"
8+
- ".github/workflows/wiki.yml"
9+
pull_request:
10+
branches: [main]
11+
paths:
12+
- "wiki/**"
13+
- ".github/workflows/wiki.yml"
14+
15+
jobs:
16+
validate:
17+
runs-on: ubuntu-latest
18+
timeout-minutes: 5
19+
20+
steps:
21+
- uses: actions/checkout@v4
22+
23+
- uses: actions/setup-node@v4
24+
with:
25+
node-version: "20"
26+
27+
- uses: actions/setup-python@v5
28+
with:
29+
python-version: "3.11"
30+
31+
- name: Check JavaScript syntax
32+
run: |
33+
node --check wiki/main.js
34+
node --check wiki/theme.js
35+
node --check wiki/docs/content.js
36+
node --check wiki/docs/main.js
37+
38+
- name: Check locale JSON
39+
run: python -m json.tool wiki/locales/en.json >/dev/null
40+
41+
- name: Check static site files
42+
run: |
43+
test -f wiki/index.html
44+
test -f wiki/home/index.html
45+
test -f wiki/docs/index.html
46+
test -f wiki/_redirects
47+
test -f wiki/_headers
48+
test -f wiki/assets/icon.png
49+
! grep -R "localhost\\|nanobot" wiki --exclude=README.md

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,12 @@ agent/tests/*_result.json
2121
.ruff_cache/
2222
frontend/dist/
2323
frontend/tsconfig.tsbuildinfo
24+
wiki/node_modules/
25+
wiki/dist/
26+
wiki/.astro/
27+
wiki/.vite/
28+
wiki/.wrangler/
29+
wiki/.cache/
2430
.vibe-dev/
2531
.vibe-record/
2632
.cache/
@@ -35,6 +41,8 @@ data/backup/
3541

3642
# Internal docs (plans, specs)
3743
docs/
44+
!wiki/docs/
45+
!wiki/docs/**
3846
data/minutes/
3947
data/overnight*.log
4048
data/*.log

wiki/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Vibe-Trading Wiki
2+
3+
Static source for `https://vibetrading.wiki`.
4+
5+
## Local preview
6+
7+
```bash
8+
cd wiki
9+
python3 -m http.server 8088
10+
```
11+
12+
Open `http://localhost:8088/home/` for the landing page and `http://localhost:8088/docs/` for the docs app.
13+
14+
Direct docs URLs such as `/docs/latest/getting-started/vibe-trading-overview` are handled by Cloudflare Pages via `_redirects`. The simple Python preview server does not apply those rewrite rules, so use `/docs/` as the local entry point.
15+
16+
## Cloudflare Pages
17+
18+
- Project root: `wiki`
19+
- Build command: leave empty
20+
- Output directory: `.`
21+
- Custom domain: `vibetrading.wiki`
22+
23+
The site is intentionally static. No server, database, or build step is required.

wiki/_headers

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/*
2+
X-Frame-Options: SAMEORIGIN
3+
X-Content-Type-Options: nosniff
4+
Referrer-Policy: strict-origin-when-cross-origin
5+
Permissions-Policy: camera=(), microphone=(), geolocation=()
6+
7+
/assets/*
8+
Cache-Control: public, max-age=31536000, immutable
9+
10+
/*.js
11+
Cache-Control: public, max-age=3600
12+
13+
/*.css
14+
Cache-Control: public, max-age=3600

wiki/_redirects

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/ /home/ 302
2+
/docs /docs/latest/getting-started/vibe-trading-overview 302
3+
/docs/ /docs/latest/getting-started/vibe-trading-overview 302
4+
/docs/latest/* /docs/index.html 200
5+
/docs/0.1.7/* /docs/index.html 200
1.31 MB
Loading
1.25 MB
Loading
1.33 MB
Loading
1.16 MB
Loading

wiki/assets/icon.png

217 KB
Loading

0 commit comments

Comments
 (0)