Merge pull request #478 from immutable/chore/rename-tutorial-dir

chore: renamed non scene/script directory to contain ~ so meta files …

Author: darrenmelvison1

.github/scripts/aggregate-passport-metadata.js

@@ -7,7 +7,7 @@ const path = require('path');
 
 // Configuration
 const PASSPORT_ROOT = './sample/Assets/Scripts/Passport';
-const TUTORIALS_DIR = path.join(PASSPORT_ROOT, '_tutorials');
+const TUTORIALS_DIR = path.join(PASSPORT_ROOT, '_tutorials~');
 const OUTPUT_DIR = './_parsed';
 const OUTPUT_FILE = path.join(OUTPUT_DIR, 'passport-features.json');
 const FEATURES_JSON_PATH = path.join(PASSPORT_ROOT, 'features.json');

.github/scripts/process-passport-tutorials.sh

@@ -8,7 +8,7 @@ DOCS_REPO_DIR="${CLONE_DIR:-"./imx-docs"}"
 
 # Root of the Passport features
 PASSPORT_ROOT="./sample/Assets/Scripts/Passport"
-TUTORIALS_DIR="${PASSPORT_ROOT}/_tutorials"
+TUTORIALS_DIR="${PASSPORT_ROOT}/_tutorials~"
 
 echo "Processing Passport tutorials..."
 
@@ -23,11 +23,11 @@ fi
 DOCS_TUTORIALS_DIR="${DOCS_REPO_DIR}/docs/main/example/zkEVM/unity/passport-examples/_tutorials"
 mkdir -p "${DOCS_TUTORIALS_DIR}"
 
-# Check if _tutorials directory exists
+# Check if _tutorials~ directory exists
 if [ ! -d "${TUTORIALS_DIR}" ]; then
-  echo "Warning: _tutorials directory not found at ${TUTORIALS_DIR}"
+  echo "Warning: _tutorials~ directory not found at ${TUTORIALS_DIR}"
 else
-  # Process each feature group directory in _tutorials
+  # Process each feature group directory in _tutorials~
   find "${TUTORIALS_DIR}" -mindepth 1 -maxdepth 1 -type d -print0 | while IFS= read -r -d '' GROUP_DIR; do
     echo "Processing feature group: ${GROUP_DIR}"
 

.github/workflows/publish-passport-tutorials.yml

@@ -7,8 +7,10 @@ on:
       # - main
       - chore/sample-app-tutorial
     paths:
+      - 'sample/Assets/Scripts/Passport/**/tutorial.md'
+      - 'sample/Assets/Scripts/Passport/**/metadata.json'
       - 'sample/Assets/Scripts/Passport/features.json'
-      - 'sample/Assets/Scripts/Passport/_tutorials/**/*'
+      - 'sample/Assets/Scripts/Passport/_tutorials~/**/*'
 
   # Allow manual triggering
   workflow_dispatch:

sample/Assets/Scripts/Passport/_prompts.meta

@@ -51,7 +51,7 @@ Before starting:
 - Note all frameworks, libraries, and dependencies used
 - IMPORTANT: Focus on the logical connections between features in the group while maintaining focus on each feature's specific implementation details.
 
-### 2. Create tutorial.md in sample/Assets/Scripts/Passport/_tutorials/{FEATURE_GROUP}/
+### 2. Create tutorial.md in sample/Assets/Scripts/Passport/_tutorials~/{FEATURE_GROUP}/
 Create a tutorial.md file for the feature group with the following structure:
 
 #### Group Introduction
@@ -118,7 +118,7 @@ Note: For single-feature cases, rename this section to "Running the Feature Exam
 - Use bulleted lists for features and steps
 - Include clear transitions between different features in the group
 
-### 3. Create metadata.json in sample/Assets/Scripts/Passport/_tutorials/{FEATURE_GROUP}/
+### 3. Create metadata.json in sample/Assets/Scripts/Passport/_tutorials~/{FEATURE_GROUP}/
 IMPORTANT: UI LIBRARY IS NOT A FEATURE OR TECH STACK. IN GENERAL, NEVER INCLUDE UI LIBRARY IN THE METADATA.JSON FILE.
 Create a metadata.json file for the feature group with the following structure:
 {