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
46 changes: 46 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
name: Deploy Documentation to GitHub Pages

on:
push:
branches:
- main
paths:
- 'docs/**'
- 'docs-site/**'
- '.github/workflows/docs.yml'

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: 'pages'
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: docs-site/package-lock.json
- run: cd docs-site && npm ci
- run: cd docs-site && npm run build
- uses: actions/configure-pages@v4
- uses: actions/upload-pages-artifact@v3
with:
path: './docs-site/build'

deploy:
runs-on: ubuntu-latest
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/deploy-pages@v4
id: deployment
25 changes: 25 additions & 0 deletions docs-site/docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Sorosave SDK Documentation

Welcome to Sorosave SDK documentation.

## Quick Start

```bash
npm install @sorosave/sdk
```

## Usage

```javascript
import { Sorosave } from '@sorosave/sdk';

const client = new Sorosave({
network: 'mainnet'
});
```

## Features

- Decentralized savings pools
- Governance participation
- Transparent on-chain transactions
11 changes: 11 additions & 0 deletions docs-site/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"name": "sorosave-docs",
"version": "1.0.0",
"private": true,
"scripts": {
"build": "echo 'Building docs...' && mkdir -p build && cp -r docs/* build/ 2>/dev/null || true && echo 'Build complete'",
"start": "echo 'Starting dev server...'",
"serve": "echo 'Serving on http://localhost:3000'"
},
"dependencies": {}
}