Skip to content

docs: rewrite the README for the actual site - #32

Merged
slin1237 merged 2 commits into
mainfrom
docs/readme-rewrite
Aug 1, 2026
Merged

docs: rewrite the README for the actual site#32
slin1237 merged 2 commits into
mainfrom
docs/readme-rewrite

Conversation

@slin1237

@slin1237 slin1237 commented Aug 1, 2026

Copy link
Copy Markdown
Member

The README was still the raw sv template ("If you're seeing this, you've probably already done this step. Congrats!"). Replaced with the real thing:

  • what the site is + live URL
  • stack (SvelteKit on Pages under /smg, D1 + Drizzle content blocks, the custom mkdocs-flavored markdown pipeline)
  • dev commands incl. db:migrate:local and the Node 22 helper
  • where content lives and how to edit it (markdown sections, nav configs, D1-seeded copy)
  • deploy pipeline + repo conventions (branch naming, conventional PR titles, DCO)
  • design credit: Studio NOIICH, Changa + Inter typography

One open question flagged separately to the owner: the delivered brand wordmark reads "Shepherd Modern Gateway" while the site and all content say "Shepherd Model Gateway" — README uses Model, matching the live site.

🤖 Generated with Claude Code

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>
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>
@slin1237

slin1237 commented Aug 1, 2026

Copy link
Copy Markdown
Member Author

@5tudiofunf

@slin1237
slin1237 merged commit 116555c into main Aug 1, 2026
6 checks passed
@slin1237
slin1237 deleted the docs/readme-rewrite branch August 1, 2026 23:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant