Skip to content

Commit a6c1db7

Browse files
authored
Merge pull request #32 from adxdits/feat/website
feat(): add a documention website
2 parents 872f9d5 + e9c4cb8 commit a6c1db7

43 files changed

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

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@ examples/
4444
## Making changes
4545

4646
1. Fork the repo and create a branch off `main`.
47-
2. Make your changes. Keep commits focused one logical change per commit.
47+
2. Make your changes. Keep commits focused one logical change per commit.
4848
3. Run `zig build test` and make sure the examples still work.
4949
4. Open a pull request.
5050

5151
## Code style
5252

5353
- Follow the existing patterns in the codebase.
54-
- No hidden allocations all allocators are passed explicitly.
54+
- No hidden allocations all allocators are passed explicitly.
5555
- Keep doc comments short and factual. Describe *what*, not *why it's amazing*.
5656
- Use `snake_case` for functions and variables, `PascalCase` for types (standard Zig conventions).
5757

0 commit comments

Comments
 (0)