Skip to content

Commit f5a802b

Browse files
committed
added website
1 parent afa762c commit f5a802b

File tree

6 files changed

+2074
-0
lines changed

6 files changed

+2074
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# Deploy API Documentation to GitHub Pages
2+
name: Deploy Documentation
3+
4+
on:
5+
# Run on pushes to main branch
6+
push:
7+
branches: [main, master]
8+
paths:
9+
- 'docs/website/**'
10+
- '.github/workflows/deploy-docs.yml'
11+
12+
# Allow manual trigger
13+
workflow_dispatch:
14+
15+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
16+
permissions:
17+
contents: read
18+
pages: write
19+
id-token: write
20+
21+
# Allow only one concurrent deployment
22+
concurrency:
23+
group: "pages"
24+
cancel-in-progress: false
25+
26+
jobs:
27+
# Build job
28+
build:
29+
runs-on: ubuntu-latest
30+
steps:
31+
- name: Checkout repository
32+
uses: actions/checkout@v4
33+
34+
- name: Setup Pages
35+
uses: actions/configure-pages@v4
36+
37+
- name: Copy website files
38+
run: |
39+
mkdir -p _site
40+
cp -r docs/website/* _site/
41+
42+
- name: Upload artifact
43+
uses: actions/upload-pages-artifact@v3
44+
with:
45+
path: '_site'
46+
47+
# Deployment job
48+
deploy:
49+
environment:
50+
name: github-pages
51+
url: ${{ steps.deployment.outputs.page_url }}
52+
runs-on: ubuntu-latest
53+
needs: build
54+
steps:
55+
- name: Deploy to GitHub Pages
56+
id: deployment
57+
uses: actions/deploy-pages@v4

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ Fula Storage provides an Amazon S3-compatible API backed by a decentralized netw
1515
- **🔄 Conflict-Free Sync**: CRDT-based metadata for distributed updates
1616
- **📈 Efficient Indexing**: Prolly Trees for O(log n) bucket operations
1717

18+
## 📖 Documentation
19+
20+
- **[API Reference](https://functionland.github.io/fula-api/)** - Complete API documentation with examples
21+
- **[SDK Examples](https://functionland.github.io/fula-api/sdk.html)** - Code examples for Rust, Python, JavaScript
22+
1823
## Architecture
1924

2025
```

0 commit comments

Comments
 (0)