Fix example ENV to be inline with production (#393)

* update example env

* update readme

Author: bryantgillespie

.env.example

@@ -1,11 +1,7 @@
-NUXT_PUBLIC_SITE_URL=http://localhost:3000
-NUXT_SITE_ENV=preview
-NUXT_PUBLIC_INKEEP_API_KEY=your_api_key_here
-NUXT_PUBLIC_INKEEP_INTEGRATION_ID=your_id_here
-NUXT_PUBLIC_INKEEP_ORGANIZATION_ID=your_id_here
-NUXT_PUBLIC_NEWSLETTER_URL=your_url_here
-NUXT_PUBLIC_PRODUCT_DIRECTUS_URL=your_url_here
-NUXT_IMAGE_DOMAINS=your_url_here
-ALGOLIA_API_KEY=
-ALGOLIA_APPLICATION_ID=
-DIRECTUS_URL=
+ALGOLIA_API_KEY=algolia_api_key
+ALGOLIA_APPLICATION_ID=algolia_application_id
+DIRECTUS_URL=https://marketing-directus-url.com
+GOOGLE_TAG_MANAGER_ID=GTM-PTLT3GH
+NUXT_UI_PRO_LICENSE=nuxt_ui_pro_license_key_needed_to_build
+POSTHOG_API_HOST=https://directus.io/ingest
+POSTHOG_API_KEY=phc_secret_key_here

README.md

@@ -8,13 +8,12 @@ Welcome! This is the repo for [Directus' documentation](https://docs.directus.io
 
 **[Learn more about Directus](https://directus.io)**
 
-<br />
 
 ## 🖥️ Running the Docs
 
 ### Requirements
 
-- Node.js 20
+- Node.js 22
 - pnpm
 
 ### Install Dependencies
@@ -25,10 +24,15 @@ pnpm install
 
 ### Setup Environment
 
+Copy the example environment file:
+
 ```bash
 cp .env.example .env
 ```
 
+Update the environment variables in the `.env` file with proper secret keys for the different
+services.
+
 ### Run Development Server
 
 Start the development server on `http://localhost:3000`:
@@ -37,18 +41,19 @@ Start the development server on `http://localhost:3000`:
 pnpm dev
 ```
 
+### Building Locally
+
+```bash
+pnpm build
+```
+
 ## ☁️ Deploying the Docs
 
-Due to [a bug in Nitro](https://github.com/nitrojs/nitro/issues/1484), Netlify isn't able to
-auto-build this website on pushes to main. Instead, a member of the core team has to deploy it
-manually through the [Netlify CLI](https://docs.netlify.com/cli/get-started/).
+The documentation automatically deploys to Vercel when changes are merged into the main branch. Simply:
 
-1. `netlify env:list --plain` – Get a copy of the `.env` you'll need to build the website
-1. `pnpm run generate` – Build the website locally
-1. `netlify deploy` – This will deploy a staging build to a branch to verify everything looks good.
-   Once that's good to go:
-1. `netlify deploy --prod` – This will then upload the same thing again but push it live to the prod
-   website
+1. Open a Pull Request with your changes
+2. This should trigger a deploy preview as well.
+3. Once PR is approved and merged to main, Vercel will automatically build and deploy the updated documentation
 
 ## 🚀 Contributing