From c828763c74a8429c88c24c1bdd794153e1dbfd86 Mon Sep 17 00:00:00 2001 From: Simo Lin <25425177+slin1237@users.noreply.github.com> Date: Sat, 1 Aug 2026 15:45:30 -0700 Subject: [PATCH 1/2] docs: rewrite the README for the actual site Replace the sv template boilerplate with real documentation: what the site is, the stack, development commands, how content editing works (markdown sections, nav config, D1-seeded copy), the deploy pipeline, and the design credit for Studio NOIICH. Signed-off-by: Simo Lin <25425177+slin1237@users.noreply.github.com> --- README.md | 54 +++++++++++++++++++++++++++--------------------------- 1 file changed, 27 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 540b3c9..b8bedf4 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,42 @@ -# sv +# SMG Documentation -Everything you need to build a Svelte project, powered by [`sv`](https://github.com/sveltejs/cli). +Documentation site for [SMG — Shepherd Model Gateway](https://github.com/smg-project/smg), the high-performance inference gateway for production LLM deployments. -## Creating a project +**Live at [lightseek.org/smg](https://lightseek.org/smg)** -If you're seeing this, you've probably already done this step. Congrats! +## Stack -```sh -# create a new project -npx sv create my-app -``` +- [SvelteKit](https://svelte.dev/docs/kit) (Svelte 5) on Cloudflare Pages, served under the `/smg` base path +- Cloudflare D1 + [Drizzle](https://orm.drizzle.team) 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 -To recreate this project with the same configuration: +Requires Node 22 (`pnpm node:use` installs and activates it via fnm) and pnpm 10. ```sh -# recreate this project -pnpm dlx sv@0.15.4 create --template minimal --types ts --add sveltekit-adapter="adapter:cloudflare+cfTarget:pages" drizzle="database:d1" prettier eslint --no-download-check --install pnpm . +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 ``` -## Developing +## Editing content -Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server: +- **Docs pages** live in `src/lib/content/
/**/*.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. -```sh -npm run dev +## Deployment -# or start the server and open the app in a new browser tab -npm run dev -- --open -``` +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](https://lightseek.org/smg); `smg-anw.pages.dev` is the underlying Pages origin, and its root redirects into `/smg`. -## Building - -To create a production version of your app: - -```sh -npm run build -``` +CI (`.github/workflows/ci.yml`) runs lint, type checks, and a production build on every pull request. Branches follow `/` naming, PR titles follow Conventional Commits, and commits are DCO-signed. -You can preview the production build with `npm run preview`. +## Design -> To deploy your app, you may need to install an [adapter](https://svelte.dev/docs/kit/adapters) for your target environment. +Brand identity and site design by [Studio NOIICH](https://studio-noiich.com). Typography: [Changa](https://fonts.google.com/specimen/Changa) and [Inter](https://rsms.me/inter/). From 9c83591fe7525e63f7b7603169fb4a70c2e93fce Mon Sep 17 00:00:00 2001 From: Simo Lin <25425177+slin1237@users.noreply.github.com> Date: Sat, 1 Aug 2026 15:59:03 -0700 Subject: [PATCH 2/2] docs: tell the actual design story in the README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Expand the design credit into the real narrative from Studio Noiich's concept decks: the Mondrian anchor (geometric equilibrium, the grid as universal order and structural clarity, mapped onto SMG's orchestration and efficiency), the gateway-arch symbol reduction, the revised palette where the radial orange glow was chosen for warmth — the humanities-and-arts half of the tech pairing — and the Changa/Inter typography. Signed-off-by: Simo Lin <25425177+slin1237@users.noreply.github.com> --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b8bedf4..039b18b 100644 --- a/README.md +++ b/README.md @@ -39,4 +39,10 @@ CI (`.github/workflows/ci.yml`) runs lint, type checks, and a production build o ## Design -Brand identity and site design by [Studio NOIICH](https://studio-noiich.com). Typography: [Changa](https://fonts.google.com/specimen/Changa) and [Inter](https://rsms.me/inter/). +The identity and site were designed by [Studio Noiich](https://studio-noiich.com) 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](https://fonts.google.com/specimen/Changa) for the wordmark and display, [Inter](https://rsms.me/inter/) for text.