docs (wip)

Author: sloanfinger

.env.example

@@ -19,6 +19,9 @@ DISCORD_GUILD_ID="1231994798165069987"
 DISCORD_PUBLIC_KEY=""
 DISCORD_TOKEN=""
 
+# Docs: GitHub API cache TTL in seconds (default: 0 locally, 300 on Vercel)
+# DOCS_CACHE_TTL=300
+
 # GitHub
 GITHUB_CLIENT_ID=""
 GITHUB_CLIENT_SECRET=""
@@ -31,5 +34,5 @@ GOOGLE_CLIENT_SECRET="aaaaaa-aa-aaaaaaaaaaaaaaaaaaaaaaaaa"
 
 # Expose Specific Auto-generated Supabase Credentials to the Client (don't change these!)
 NEXT_PUBLIC_SUPABASE_URL=$API_URL
-NEXT_PUBLIC_SUPABASE_ANON_KEY=$ANON_KEY
+NEXT_PUBLIC_SUPABASE_PUBLISHABLE_KEY=$PUBLISHABLE_KEY
 NEXT_PUBLIC_AVATARS_BUCKET="avatars"

.gitignore

@@ -51,4 +51,6 @@ volumes/s3/*
 
 # supabase
 supabase/*
-!supabase/config.toml
+!supabase/config.toml
+src/supabase/types.d.ts
+src/supabase/drizzle

docs/contributing.md

@@ -0,0 +1,38 @@
+---
+title: Contributing
+description: Guidelines for contributing to the DevDogs Website.
+---
+
+# Contributing
+
+Thanks for helping improve the DevDogs Website!
+
+## Workflow
+
+1. **Fork** the repository and create a feature branch from `main`.
+2. **Make your changes** — keep commits focused and descriptive.
+3. **Open a pull request** targeting `main`. Fill out the PR template.
+
+## Code style
+
+- TypeScript everywhere — avoid `any`.
+- Run `pnpm check` before pushing (lints, typechecks, and formats).
+- Prefer editing existing files over creating new ones.
+
+## Database changes
+
+Schema lives in `src/server/db/schema/`. After editing, run:
+
+```bash
+pnpm db:push
+```
+
+This pulls the introspected schema, pushes migrations, and regenerates Supabase types.
+
+## Documentation
+
+Add or update markdown files in `docs/` alongside your code changes. Use the local preview to check rendering:
+
+```bash
+pnpm docs:preview
+```

docs/getting-started.md

@@ -0,0 +1,45 @@
+---
+title: Getting Started
+description: Set up the DevDogs Website locally for development.
+---
+
+# Getting Started
+
+## Prerequisites
+
+- [Node.js](https://nodejs.org) 18 or later
+- [pnpm](https://pnpm.io) 9 or later
+- [Docker](https://www.docker.com) (for the local Supabase instance)
+
+## Installation
+
+1. **Clone the repo**
+
+   ```bash
+   git clone https://github.com/DevDogs-UGA/DevDogs-Website.git
+   cd DevDogs-Website
+   ```
+
+2. **Install dependencies**
+
+   ```bash
+   pnpm install
+   ```
+
+3. **Start the local Supabase instance and dev server**
+
+   ```bash
+   pnpm dev
+   ```
+
+   This starts Supabase locally, runs database migrations, and launches the Next.js dev server at `http://localhost:3000`.
+
+## Local docs preview
+
+To preview documentation changes before pushing:
+
+```bash
+pnpm docs:preview
+```
+
+Then visit `/docs/local` on the running site. The page auto-refreshes when you edit any file in `docs/`.

docs/index.md

@@ -0,0 +1,23 @@
+---
+title: DevDogs Website
+description: The official DevDogs UGA club website.
+---
+
+# DevDogs Website
+
+Welcome to the documentation for the DevDogs Website — the open-source web platform for the DevDogs club at the University of Georgia.
+
+## What's in here
+
+- **Getting started** — how to set up the project locally
+- **Contributing** — guidelines for submitting pull requests
+
+## Tech stack
+
+| Layer | Technology |
+|-------|-----------|
+| Framework | Next.js 15 (App Router) |
+| Database | Supabase (Postgres) |
+| ORM | Drizzle ORM |
+| Styling | Tailwind CSS v4 |
+| Auth | Supabase Auth |

drizzle-introspection.config.ts

@@ -0,0 +1,17 @@
+import { type Config } from "drizzle-kit";
+import { loadEnvConfig } from "@next/env";
+
+loadEnvConfig(process.cwd());
+
+export default {
+  out: "./src/supabase/drizzle",
+  dialect: "postgresql",
+  casing: "camelCase",
+  schemaFilter: ["*", "!public", "!_*"],
+  dbCredentials: {
+    url: process.env.DB_URL!,
+  },
+  introspect: {
+    casing: "camel",
+  }
+} satisfies Config;

drizzle.config.ts drizzle-migrations.config.tsdrizzle.config.ts renamed to drizzle-migrations.config.ts

@@ -4,18 +4,11 @@ import { loadEnvConfig } from "@next/env";
 loadEnvConfig(process.cwd());
 
 export default {
-  schema: "./src/server/db/schema/tables.ts",
+  schema: "./src/server/db/schema/index.ts",
   dialect: "postgresql",
-  out: "./drizzle",
   casing: "camelCase",
   schemaFilter: ["public"],
   dbCredentials: {
     url: process.env.DB_URL!,
   },
-  entities: {
-    roles: {
-      provider: "supabase",
-      exclude: ["supabase_auth_admin"],
-    },
-  },
 } satisfies Config;

next.config.ts

@@ -31,7 +31,7 @@ const config = {
     remotePatterns: [
       new URL("/storage/v1/object/public/**", env.NEXT_PUBLIC_SUPABASE_URL),
     ],
-    // dangerouslyAllowLocalIP: env.NODE_ENV !== "production"
+    dangerouslyAllowLocalIP: env.NODE_ENV !== "production"
   },
 } satisfies NextConfig;
 

package.json

@@ -6,14 +6,13 @@
   "scripts": {
     "build": "next build",
     "check": "pnpm run lint:fix && pnpm run typecheck && pnpm run prettier",
-    "db:generate": "drizzle-kit generate",
-    "db:migrate": "drizzle-kit migrate",
-    "db:push": "drizzle-kit push",
+    "db:push": "drizzle-kit pull --config drizzle-introspection.config.ts && drizzle-kit push --config drizzle-migrations.config.ts && supabase gen types --local > src/supabase/types.d.ts",
     "sb:seed": "dotenv -v next_public_avatars_bucket=$NEXT_PUBLIC_AVATARS_BUCKET -- supabase seed buckets --yes",
     "sb:start": "dotenv -- supabase start && supabase status -o env > .env.local && dotenv -- pnpm sb:seed",
     "sb:stop": "supabase stop",
     "sb:restart": "pnpm sb:stop && pnpm sb:start",
     "dev": "pnpm sb:start && pnpm db:push && pnpm next dev",
+    "docs:preview": "docs-preview",
     "format:check": "prettier --check \"**/*.{ts,tsx,js,jsx,mdx}\" --cache",
     "format:write": "prettier --write \"**/*.{ts,tsx,js,jsx,mdx}\" --cache",
     "lint": "eslint src",
@@ -46,19 +45,27 @@
     "date-fns": "^4.1.0",
     "discord-api-types": "^0.38.44",
     "discord-interactions": "^4.4.0",
-    "drizzle-orm": "1.0.0-beta.20",
+    "drizzle-orm": "1.0.0-beta.21",
+    "fumadocs-core": "^16.7.11",
+    "fumadocs-ui": "^16.7.11",
+    "gray-matter": "^4.0.3",
     "next": "^16.2.2",
+    "next-mdx-remote": "^6.0.0",
     "open-graph-scraper": "^6.11.0",
     "postgres": "^3.4.8",
     "react": "^19.2.4",
     "react-dom": "^19.2.4",
     "react-fast-marquee": "^1.6.5",
     "react-icons": "^5.6.0",
     "react-image-crop": "^11.0.10",
+    "react-markdown": "^10.1.0",
+    "remark-frontmatter": "^5.0.0",
+    "remark-gfm": "^4.0.1",
     "zod": "4.1.8",
     "zod-form-data": "^3.0.1"
   },
   "devDependencies": {
+    "@devdogsuga/docs-preview": "workspace:*",
     "@eslint/eslintrc": "^3.3.5",
     "@next/env": "^16.2.2",
     "@supabase/auth-js": "^2.101.1",
@@ -68,7 +75,7 @@
     "@types/react": "^19.2.14",
     "@types/react-dom": "^19.2.3",
     "dotenv-cli": "^10.0.0",
-    "drizzle-kit": "1.0.0-beta.20",
+    "drizzle-kit": "1.0.0-beta.21",
     "eslint": "^9.39.4",
     "eslint-config-next": "^15.5.14",
     "eslint-plugin-drizzle": "^0.2.3",

packages/docs-preview/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};