From f052afad6b4f2e8d7a3f347c0c735314a1c35850 Mon Sep 17 00:00:00 2001
From: Andre Vitorio <andre@vitorio.net>
Date: Fri, 9 Feb 2024 12:03:33 -0300
Subject: [PATCH] chore: improve contribution docs (#184)

---
 CONTRIBUTING.md             |  2 +-
 apps/dev/.env.local.example | 23 ++++++++---------------
 package.json                |  2 +-
 3 files changed, 10 insertions(+), 17 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7dccc003..be392292 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -68,7 +68,7 @@ There are a few particularities to how Outstatic works. Since most editor action
    ```
 1. Start developing and watch for code changes:
    ```
-   pnpm dev --filter outstatic-dev-blog --filter outstatic
+   pnpm dev
    ```
    The above command will tell turborepo to only load the `outstatic` library and the `outstatic-dev-blog` project.
 1. When your changes are finished, commit them to the branch:
diff --git a/apps/dev/.env.local.example b/apps/dev/.env.local.example
index 6bec46ff..c9e0432c 100644
--- a/apps/dev/.env.local.example
+++ b/apps/dev/.env.local.example
@@ -1,24 +1,17 @@
 NEXT_PUBLIC_APP_URL=http://localhost:3000
 
+# The `/apps/dev/` folder is a Next.js app that is used to develop and test Outstatic.
 # REQUIRED Environment variables
 OST_GITHUB_ID=YOUR_GITHUB_OAUTH_ID
 OST_GITHUB_SECRET=YOUR_GITHUB_OAUTH_SECRET
 OST_TOKEN_SECRET=A_32CHAR_RANDOM_STRING_FOR_YOUR_TOKEN_SECRET
-OST_REPO_SLUG=THE_REPOSITORY_SLUG 
-# If empty AND on Vercel, your OST_REPO_SLUG defaults to VERCEL_GIT_REPO_SLUG
+OST_REPO_SLUG=outstatic
+OST_REPO_BRANCH=main
+OST_CONTENT_PATH=outstatic/content
+OST_MONOREPO_PATH=apps/dev
 
-# OPTIONAL Environment variables
 
-# If empty, OST_REPO_BRANCH defaults to main
-# OST_REPO_BRANCH=THE_REPOSITORY_BRANCH
+# For more information visit: https://outstatic.com/docs/environment-variables
 
-# # If empty, OST_REPO_OWNER the GitHub username of the logged in account will be used
-# OST_REPO_OWNER=THE_REPO_OWNER
-
-# # OST_CONTENT_PATH is the path of where content is saved, if empty it defaults to outstatic/content
-# OST_CONTENT_PATH=outstatic/content 
-
-# # Specify monorepo folder of your Outstatic content
-# OST_MONOREPO_PATH=apps/web
-
-# For more information visit: https://outstatic.com/docs/environment-variables
\ No newline at end of file
+# If you want to deploy your own instance of Outstatic visit https://outstatic.com/docs/getting-started
+# You can also download the repository and use the `/examples/blog` folder as a starting point for your own site.
\ No newline at end of file
diff --git a/package.json b/package.json
index 659eab7b..7706d702 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,7 @@
   ],
   "scripts": {
     "build": "turbo run build",
-    "dev": "turbo run dev",
+    "dev": "turbo run dev --filter=outstatic-dev-blog --filter=outstatic",
     "lint": "turbo run lint",
     "clean": "turbo run clean",
     "format": "prettier --write",