Skip to content

README.md

Latest commit

 

History

History
50 lines (33 loc) · 4.06 KB

README.md

File metadata and controls

50 lines (33 loc) · 4.06 KB
Raw

SMG Documentation

Documentation site for SMG — Shepherd Model Gateway, the high-performance inference gateway for production LLM deployments.

Live at lightseek.org/smg

Stack

  • SvelteKit (Svelte 5) on Cloudflare Pages, served under the /smg base path
  • Cloudflare D1 + Drizzle for editable content blocks (home and section copy)
  • A custom markdown pipeline that renders mkdocs-material-flavored content — tabbed blocks, admonitions, collapsibles, card grids, and a generated table of contents — via marked and highlight.js

Development

Requires Node 22 (pnpm node:use installs and activates it via fnm) and pnpm 10.

pnpm install
pnpm dev                # vite dev server
pnpm db:migrate:local   # apply D1 migrations to the local database
pnpm check              # wrangler types --check + svelte-check
pnpm lint               # prettier + eslint
pnpm build              # production build
pnpm preview            # serve the built site with wrangler pages dev

Editing content

  • Docs pages live in src/lib/content/<section>/**/*.md (getting-started, concepts, reference, contributing). mkdocs-material syntax — === "Tab" blocks, !!! note admonitions, ??? question collapsibles, card grids — is supported by the pipeline in src/lib/markdown/.
  • Navigation is data in src/lib/config/*-nav.ts.
  • Home and section headline copy is seeded into D1 (content_blocks table) by the migrations in drizzle/, with static fallbacks in src/lib/content/defaults.ts.
  • Every docs page links back to its source file in this repository via the Edit button.

Deployment

Every push to main runs .github/workflows/deploy.yml: build, apply D1 migrations to smg-db, and deploy to the smg Cloudflare Pages project. The production URL is lightseek.org/smg; smg-anw.pages.dev is the underlying Pages origin, and its root redirects into /smg.

The header badge reads stars, forks, and the latest release from the GitHub API at request time. Set a GITHUB_TOKEN secret on the Pages project (wrangler pages secret put GITHUB_TOKEN --project-name smg; any token that can read public repositories works) so those calls are authenticated: unauthenticated calls share GitHub's 60-requests-per-hour limit per egress IP with every other Worker on Cloudflare, and the badge hides its counts whenever GitHub cannot be reached. Results are cached per edge location for 15 minutes and served stale for up to a day while refreshes fail. Locally, pnpm preview reads the token from .dev.vars.

CI (.github/workflows/ci.yml) runs lint, type checks, and a production build on every pull request. Branches follow <type>/<description> naming, PR titles follow Conventional Commits, and commits are DCO-signed.

Design

The identity and site were designed by Studio Noiich through a two-round concept process (May–June 2026), positioned deliberately at the interaction of tech and the humanities & arts.

The visual anchor is Piet Mondrian: his work distills complex reality into a perfect geometric equilibrium, with the grid standing for universal order and structural clarity. That maps directly onto what SMG does with inference traffic — orchestration as geometric equilibrium, efficiency as structural clarity — and the grid discipline runs through the whole site.

  • Symbol — a gateway arch set into a Mondrian-like grid, progressively reduced until only the rounded arch remains: the mark that anchors the home hero and the favicon.
  • Color — solid tech black and warm paper off-whites around the signature radial orange glow. Orange was chosen for its warmth — the humanities-and-arts half of the pairing, balancing the cool precision of the tech side — and the glow renders live as the home hero's shader background.
  • Typography — Changa for the wordmark and display, Inter for text.