Skip to content
Merged
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
12 changes: 12 additions & 0 deletions .claude/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"version": "0.0.1",
"configurations": [
{
"name": "docs",
"runtimeExecutable": "pnpm",
"runtimeArgs": ["docs:dev"],
"port": 5173,
"cwd": "docs"
}
]
}
59 changes: 59 additions & 0 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Deploy Docs

on:
push:
branches: [main]
paths:
- "docs/**"
- ".github/workflows/docs.yaml"

workflow_dispatch:

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

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

jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: pnpm/action-setup@v4
with:
version: 10

- uses: actions/setup-node@v4
with:
node-version: 22
cache: pnpm
cache-dependency-path: docs/pnpm-lock.yaml

- name: Install dependencies
run: pnpm install --frozen-lockfile
working-directory: docs

- name: Build docs
run: pnpm docs:build
working-directory: docs

- uses: actions/upload-pages-artifact@v3
with:
path: docs/.vitepress/dist

deploy:
name: Deploy
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- uses: actions/deploy-pages@v4
id: deployment
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@ scripts/task_definition.json
target
.wrangler
.env*
node_modules
docs/.vitepress/cache
docs/.vitepress/dist
166 changes: 166 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,166 @@
import { defineConfig } from "vitepress";
import { withMermaid } from "vitepress-plugin-mermaid";

const adminSidebar = [
{
text: "Getting Started",
items: [
{ text: "Quick Start", link: "/getting-started/" },
{
text: "Local Development",
link: "/getting-started/local-development",
},
],
},
{
text: "Configuration",
items: [
{ text: "Overview", link: "/configuration/" },
{ text: "Buckets", link: "/configuration/buckets" },
{ text: "Roles", link: "/configuration/roles" },
{ text: "Credentials", link: "/configuration/credentials" },
{
text: "Providers",
collapsed: false,
items: [
{ text: "Overview", link: "/configuration/providers/" },
{
text: "Static File",
link: "/configuration/providers/static-file",
},
{ text: "HTTP API", link: "/configuration/providers/http" },
{
text: "DynamoDB",
link: "/configuration/providers/dynamodb",
},
{
text: "PostgreSQL",
link: "/configuration/providers/postgres",
},
{
text: "Caching",
link: "/configuration/providers/cached",
},
],
},
],
},
{
text: "Authentication",
items: [
{ text: "Overview", link: "/auth/" },
{
text: "Client Auth (OIDC/STS)",
link: "/auth/proxy-auth",
},
{
text: "Backend Auth",
link: "/auth/backend-auth",
},
{ text: "Sealed Session Tokens", link: "/auth/sealed-tokens" },
],
},
{
text: "Deployment",
items: [
{ text: "Overview", link: "/deployment/" },
{ text: "Server Runtime", link: "/deployment/server" },
{
text: "Cloudflare Workers",
link: "/deployment/cloudflare-workers",
},
],
},
{
text: "Architecture",
items: [
{ text: "Overview", link: "/architecture/" },
{ text: "Crate Layout", link: "/architecture/crate-layout" },
{
text: "Request Lifecycle",
link: "/architecture/request-lifecycle",
},
{
text: "Multi-Runtime Design",
link: "/architecture/multi-runtime",
},
],
},
{
text: "Extending",
items: [
{ text: "Overview", link: "/extending/" },
{ text: "Custom Resolver", link: "/extending/custom-resolver" },
{ text: "Custom Provider", link: "/extending/custom-provider" },
{ text: "Custom Backend", link: "/extending/custom-backend" },
],
},
];

export default withMermaid(
defineConfig({
title: "Source Data Proxy",
description: "Multi-runtime S3 gateway proxy in Rust",

themeConfig: {
nav: [
{ text: "User Guide", link: "/guide/" },
{ text: "Administration", link: "/getting-started/" },
{ text: "Reference", link: "/reference/" },
],

sidebar: {
"/guide/": [
{
text: "User Guide",
items: [
{ text: "Overview", link: "/guide/" },
{ text: "Endpoints", link: "/guide/endpoints" },
{ text: "Authentication", link: "/guide/authentication" },
{ text: "Client Usage", link: "/guide/client-usage" },
],
},
],

"/getting-started/": adminSidebar,
"/configuration/": adminSidebar,
"/auth/": adminSidebar,
"/deployment/": adminSidebar,
"/architecture/": adminSidebar,
"/extending/": adminSidebar,

"/reference/": [
{
text: "Reference",
items: [
{ text: "Overview", link: "/reference/" },
{
text: "Supported Operations",
link: "/reference/operations",
},
{ text: "Error Codes", link: "/reference/errors" },
{ text: "Config Example", link: "/reference/config-example" },
],
},
],
},

socialLinks: [
{
icon: "github",
link: "https://github.com/source-cooperative/data.source.coop",
},
],

search: {
provider: "local",
},

footer: {
message: "Released under the MIT / Apache-2.0 License.",
copyright:
'A <a href="https://radiant.earth" target="_blank">Radiant Earth</a> project. Copyright &copy; 2026 <a href="https://source.coop" target="_blank">Source Cooperative</a>.',
},
},
}),
);
4 changes: 4 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
import DefaultTheme from "vitepress/theme";
import "./style.css";

export default DefaultTheme;
Loading