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
7 changes: 6 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,12 @@ jobs:
exit 1

- name: Check formatting
run: test -z "$(gofmt -l .)"
run: |
UNFORMATTED="$(find . -name '*.go' -not -path './.git/*' -print0 | xargs -0 gofmt -l)"
if [ -n "$UNFORMATTED" ]; then
echo "$UNFORMATTED"
exit 1
fi

- name: Check go mod tidy
run: |
Expand Down
51 changes: 51 additions & 0 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: Cloudflare Docs

on:
push:
branches: [master]
paths:
- "docs/**"
- "src/**"
- "static/**"
- "docusaurus.config.js"
- "sidebars.js"
- "package.json"
- "package-lock.json"
- "wrangler.jsonc"
- ".github/workflows/docs-deploy.yml"
workflow_dispatch:

permissions:
contents: read

jobs:
deploy:
runs-on: ubuntu-latest
env:
CLOUDFLARE_API_TOKEN: ${{ secrets.CLOUDFLARE_API_TOKEN }}

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: npm
cache-dependency-path: package-lock.json

- name: Install dependencies
run: npm ci

- name: Build docs
run: npm run docs:build

- name: Deploy docs to Cloudflare Workers
if: env.CLOUDFLARE_API_TOKEN != ''
run: npx wrangler deploy

- name: Skip deploy without Cloudflare token
if: env.CLOUDFLARE_API_TOKEN == ''
run: |
echo "::notice::Set CLOUDFLARE_API_TOKEN as a repository secret to enable automatic docs deployment."
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,8 @@ are useful, instead of forcing tool calls in the harness.

## Documentation

The docs site lives in [docs](docs) and is built with Docusaurus.
The docs site lives in [docs](docs), is built with Docusaurus, and is deployed
to Cloudflare Workers at <https://membrane.gustycube.com>.

```bash
npm install
Expand All @@ -289,9 +290,12 @@ npm run docs:build
npm run docs:deploy
```

Cloudflare configuration is in [wrangler.jsonc](wrangler.jsonc). Sidebar and
theme configuration live in [sidebars.js](sidebars.js) and
[docusaurus.config.js](docusaurus.config.js).
Cloudflare configuration is in [wrangler.jsonc](wrangler.jsonc). The GitHub
Actions deploy workflow runs when docs files change and deploys when
`CLOUDFLARE_API_TOKEN` is present as a repository secret. The
`membrane.gustycube.com` DNS record must be proxied through Cloudflare for the
Worker route to receive production traffic. Sidebar and theme configuration live
in [sidebars.js](sidebars.js) and [docusaurus.config.js](docusaurus.config.js).

## API Surface

Expand Down
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
const config = {
title: "Membrane",
tagline: "A selective learning and memory substrate for LLM and agentic systems.",
url: process.env.DOCS_SITE_URL ?? "https://membrane-docs.bennettschwartz32.workers.dev",
url: process.env.DOCS_SITE_URL ?? "https://membrane.gustycube.com",
baseUrl: "/",
organizationName: "BennettSchwartz",
projectName: "membrane",
Expand Down
2 changes: 1 addition & 1 deletion pkg/ingestion/capture_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ import (
"time"

"github.com/BennettSchwartz/membrane/pkg/schema"
sqlitestore "github.com/BennettSchwartz/membrane/pkg/storage/sqlite"
"github.com/BennettSchwartz/membrane/pkg/storage"
sqlitestore "github.com/BennettSchwartz/membrane/pkg/storage/sqlite"
)

type stubInterpreter struct {
Expand Down
6 changes: 6 additions & 0 deletions wrangler.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
"name": "membrane-docs",
"account_id": "776e99cad6263022ce616ccd9c25663e",
"workers_dev": true,
"routes": [
{
"pattern": "membrane.gustycube.com/*",
"zone_name": "gustycube.com"
}
],
"compatibility_date": "2026-04-30",
"assets": {
"directory": "./build",
Expand Down
Loading