Skip to content

Commit 1352543

Browse files
Scaffold Catalyst docs hub
Add a Docusaurus (TS) site with workspace scripts, local search, CI build + GitHub Pages deploy, and initial multi-audience docs (operators, wallets, builders) cross-linked to canonical repos. Made-with: Cursor
1 parent 1a32ad5 commit 1352543

71 files changed

Lines changed: 22372 additions & 1 deletion

Some content is hidden

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

.github/workflows/ci.yml

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name: CI
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [main]
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
timeout-minutes: 15
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
16+
- name: Setup Node
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: 22
20+
cache: npm
21+
22+
- name: Install
23+
run: npm ci
24+
25+
- name: Typecheck
26+
run: npm run typecheck
27+
28+
- name: Build (checks internal links)
29+
run: npm run build
30+

.github/workflows/pages.yml

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

.gitignore

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Dependencies
2+
node_modules/
3+
4+
# Docusaurus build artifacts
5+
site/build/
6+
site/.docusaurus/
7+
site/.cache/
8+
9+
# Local env / OS noise
10+
.env
11+
.env.*
12+
.DS_Store
13+
*.log
14+

README.md

Lines changed: 45 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,45 @@
1-
# catalyst-docs
1+
# Catalyst Docs
2+
3+
Single, public documentation hub for the Catalyst ecosystem (operators, wallets, builders, protocol + RPC reference).
4+
5+
## Local development
6+
7+
Prereqs:
8+
- Node.js >= 20
9+
10+
Install:
11+
12+
```bash
13+
npm install
14+
```
15+
16+
Run locally:
17+
18+
```bash
19+
npm run start
20+
```
21+
22+
Build:
23+
24+
```bash
25+
npm run build
26+
```
27+
28+
Serve the production build locally:
29+
30+
```bash
31+
npm run serve
32+
```
33+
34+
## Repo layout
35+
36+
- `site/`: Docusaurus app (config, theme, docs content)
37+
38+
## Deploy (GitHub Pages)
39+
40+
This repo is set up to build the site on every PR, and deploy `site/build/` to GitHub Pages on merges to `main`.
41+
42+
Notes:
43+
- For project pages, Docusaurus uses `baseUrl: "/catalyst-docs/"`.
44+
- The deployed URL will be the org GitHub Pages host + repo path (example: `https://catalyst-network.github.io/catalyst-docs/`).
45+

0 commit comments

Comments
 (0)