Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 54 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Docs

on:
push:
branches: [main]
paths: ['docs/**', 'website/**', '.github/workflows/docs.yml']
pull_request:
paths: ['docs/**', 'website/**', '.github/workflows/docs.yml']
workflow_dispatch:

permissions:
contents: read

concurrency:
group: pages
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Use Node.js 22
uses: actions/setup-node@v4
with:
node-version: 22
cache: npm
cache-dependency-path: website/package-lock.json
- run: npm ci
working-directory: website
- run: npm run typecheck
working-directory: website
- run: npm run build
working-directory: website
- name: Upload Pages artifact
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
uses: actions/upload-pages-artifact@v3
with:
path: website/build

deploy:
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
5 changes: 5 additions & 0 deletions docs/api-overview.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: API Overview
description: High-level API reference for the ZNN TypeScript SDK.
---

# API Overview

High-level API reference for the ZNN TypeScript SDK.
Expand Down
5 changes: 5 additions & 0 deletions docs/build-wasm.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Building WASM
description: Rebuilding the PoW WebAssembly module from source.
---

# Building the PoW WASM Module

This SDK includes a pre-built WebAssembly module for Proof of Work (PoW) computation. Use this guide to rebuild it from source if you need transparency or customization.
Expand Down
5 changes: 5 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: CLI Tool
description: Command-line interface for wallet management and transactions.
---

# CLI Tool

The ZNN TypeScript SDK includes a command-line interface for common operations and scripting.
Expand Down
5 changes: 5 additions & 0 deletions docs/examples.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_label: Examples
description: Complete working examples for the ZNN TypeScript SDK.
---

# Examples

Each snippet is ready to drop into a script and expand.
Expand Down
Loading