docs/.vitepress/config.ts

@@ -140,7 +140,7 @@ export default defineConfig({
         text: 'User Guide',
         collapsed: false,
         items: [
-          { text: 'Project Setup', link: '/user-guide/project-setup/intro' },
+          { text: 'Project Overview', link: '/user-guide/project-overview' },
           { text: 'Running Blender', link: '/user-guide/running_blender' },
           {
             text: 'Organization',

docs/index.md

@@ -11,7 +11,7 @@ hero:
       link: /pipeline-overview/introduction
     - theme: alt
       text: User Guide
-      link: /user-guide/project-setup/intro
+      link: /user-guide/project-overview
 
 features:
   - title: Free Software

docs/user-guide/project-overview.md

@@ -0,0 +1,78 @@
+# Project Overview
+
+The Blender Studio Pipeline's folders structure is designed to be simple and easy to deploy on all operating systems. The project folder contains all data related to a project including .blend files, playblasts, the blender that is used on the project for all operating systems and even preferences are stored within the project. 
+
+Typically projects are stored at the following path `/data/{my_project}` where `data` is at the root of the filesystem. This means that absolute paths between operating systems will be the same. This is how the Blender Studio lays out their directories. External studios can use a different root folder for their projects (for example a user's home folder) but the studio TDs will be responsible for ensuring all paths are valid when syncing between operating systems.
+ 
+## Directory Layout
+
+### Project Layout
+
+The project folder contains all data about the current project, this directory is populated by the `run_blender.py` script with the Blender & Add-Ons from `shared`.
+ * `local` This is where the local copy of Blender and the add-ons will be installed.
+ * `shared` This is the folder that should be shared over the network, it contains renders, playblast and other items that don't require version control. (By using Syncthing, NFS shares, Samba, Dropbox, etc)
+ * `svn` This the versioned controlled folder where the .blend production files will live.
+
+```bash
+.
+└── my_project/
+    ├── local # The local copy of Blender and the add-ons will be installed.
+    ├── shared # Shared over the network (Syncthing, NFS, Dropbox, etc)
+    └── svn # Contains the `.blend` production files. (SVN, GIT-LFS, etc)
+```
+
+
+
+### Shared
+This is the folder that should be shared over the network. (By using Syncthing, NFS shares, Samba, Dropbox, etc) Connect this folder to your sharing software of choice and create the following folder structure.
+
+<!--- TODO Replace with new folder structure --->
+
+```bash
+.
+├── bts # Behind the scenes
+├── concepts # Concept art and paintings
+├── development # Piches and boards
+├── edit # VSE Editing sequences/exports
+├── inspiration # Various inspirations & references
+├── music 
+├── planning 
+├── pr
+├── resources 
+├── script # Latest scripts for the movie
+├── shot_packs # Shots for sharing online
+├── training # Training produced for the production
+└── videoref # Video shoots from animators
+```
+
+
+### SVN
+This is the folder that should contain a version controlled file system to be shared over the network. (By using SVN, GIT-LFS, etc) Connect this folder to your version control software of choice and create the following folder structure.
+
+```bash
+.
+└── svn  /
+    ├── dev / # Anything related to early development or tests
+    │   ├── boards
+    │   ├── concepts
+    │   └── tests
+    ├── pre/ # For pre-production
+    │   ├── assets
+    │   └── shots
+    ├── pro/ # All files from the production
+    │   ├── assets/ # All assets from the production
+    │   │   ├── cam # Camera rig & setup
+    │   │   ├── chars # Characters & character variations
+    │   │   ├── fx # Effects
+    │   │   ├── lgt # Lighting setups
+    │   │   ├── lib
+    │   │   ├── maps # General textures and HDRIs
+    │   │   ├── nodes # General Node groups
+    │   │   ├── poses # Pose libraries for animation
+    │   │   ├── props
+    │   │   ├── scripts
+    │   │   └── sets
+    │   ├── config
+    │   └── shots #Structured into sequences
+    └── tools
+```

docs/user-guide/project-setup/intro.md

@@ -1,13 +0,0 @@
-# Project Setup
-
-::: warning Work in Progress
-30 Apr. 2023 - The content of this page is currently being edited/updated.
-:::
-
-Write how to set up a project in a fully configured workstation and production enviroment. Probably links to other parts of the reference.
-
-* Ensure SVN access
-* Ensure that Blender is configured with the 'shared' add-ons directory
-* Ensure Kitsu access
-* Checkout SVN project in the appropriate location
-* ...