diff --git a/.github/scripts/aggregate-passport-metadata.js b/.github/scripts/aggregate-passport-metadata.js index 1f0dd3bd..98568cd7 100755 --- a/.github/scripts/aggregate-passport-metadata.js +++ b/.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'); diff --git a/.github/scripts/process-passport-tutorials.sh b/.github/scripts/process-passport-tutorials.sh index 1100e3ce..903e51ae 100755 --- a/.github/scripts/process-passport-tutorials.sh +++ b/.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}" diff --git a/.github/workflows/publish-passport-tutorials.yml b/.github/workflows/publish-passport-tutorials.yml index 44f07ee7..e7881ae9 100644 --- a/.github/workflows/publish-passport-tutorials.yml +++ b/.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: diff --git a/sample/Assets/Scripts/Passport/_prompts.meta b/sample/Assets/Scripts/Passport/_prompts.meta deleted file mode 100644 index e3d610fa..00000000 --- a/sample/Assets/Scripts/Passport/_prompts.meta +++ /dev/null @@ -1,8 +0,0 @@ -fileFormatVersion: 2 -guid: 06dbe53050fc34034bcc8560d082b6f8 -folderAsset: yes -DefaultImporter: - externalObjects: {} - userData: - assetBundleName: - assetBundleVariant: diff --git a/sample/Assets/Scripts/Passport/_prompts/tutorial-generation-prompt.txt b/sample/Assets/Scripts/Passport/_prompts~/tutorial-generation-prompt.txt similarity index 99% rename from sample/Assets/Scripts/Passport/_prompts/tutorial-generation-prompt.txt rename to sample/Assets/Scripts/Passport/_prompts~/tutorial-generation-prompt.txt index 21a5d22c..b8bf1209 100644 --- a/sample/Assets/Scripts/Passport/_prompts/tutorial-generation-prompt.txt +++ b/sample/Assets/Scripts/Passport/_prompts~/tutorial-generation-prompt.txt @@ -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: { diff --git a/sample/Assets/Scripts/Passport/_prompts/tutorial-generation-prompt.txt.meta b/sample/Assets/Scripts/Passport/_prompts~/tutorial-generation-prompt.txt.meta similarity index 100% rename from sample/Assets/Scripts/Passport/_prompts/tutorial-generation-prompt.txt.meta rename to sample/Assets/Scripts/Passport/_prompts~/tutorial-generation-prompt.txt.meta diff --git a/sample/Assets/Scripts/Passport/_tutorials/Authentication/metadata.json b/sample/Assets/Scripts/Passport/_tutorials~/Authentication/metadata.json similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/Authentication/metadata.json rename to sample/Assets/Scripts/Passport/_tutorials~/Authentication/metadata.json diff --git a/sample/Assets/Scripts/Passport/_tutorials/Authentication/tutorial.md b/sample/Assets/Scripts/Passport/_tutorials~/Authentication/tutorial.md similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/Authentication/tutorial.md rename to sample/Assets/Scripts/Passport/_tutorials~/Authentication/tutorial.md diff --git a/sample/Assets/Scripts/Passport/_tutorials/ClearStorageAndCache/metadata.json b/sample/Assets/Scripts/Passport/_tutorials~/ClearStorageAndCache/metadata.json similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/ClearStorageAndCache/metadata.json rename to sample/Assets/Scripts/Passport/_tutorials~/ClearStorageAndCache/metadata.json diff --git a/sample/Assets/Scripts/Passport/_tutorials/ClearStorageAndCache/tutorial.md b/sample/Assets/Scripts/Passport/_tutorials~/ClearStorageAndCache/tutorial.md similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/ClearStorageAndCache/tutorial.md rename to sample/Assets/Scripts/Passport/_tutorials~/ClearStorageAndCache/tutorial.md diff --git a/sample/Assets/Scripts/Passport/_tutorials/GetUserInfo/metadata.json b/sample/Assets/Scripts/Passport/_tutorials~/GetUserInfo/metadata.json similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/GetUserInfo/metadata.json rename to sample/Assets/Scripts/Passport/_tutorials~/GetUserInfo/metadata.json diff --git a/sample/Assets/Scripts/Passport/_tutorials/GetUserInfo/tutorial.md b/sample/Assets/Scripts/Passport/_tutorials~/GetUserInfo/tutorial.md similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/GetUserInfo/tutorial.md rename to sample/Assets/Scripts/Passport/_tutorials~/GetUserInfo/tutorial.md diff --git a/sample/Assets/Scripts/Passport/_tutorials/Imx/metadata.json b/sample/Assets/Scripts/Passport/_tutorials~/Imx/metadata.json similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/Imx/metadata.json rename to sample/Assets/Scripts/Passport/_tutorials~/Imx/metadata.json diff --git a/sample/Assets/Scripts/Passport/_tutorials/Imx/tutorial.md b/sample/Assets/Scripts/Passport/_tutorials~/Imx/tutorial.md similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/Imx/tutorial.md rename to sample/Assets/Scripts/Passport/_tutorials~/Imx/tutorial.md diff --git a/sample/Assets/Scripts/Passport/_tutorials/PassportInitialisation/metadata.json b/sample/Assets/Scripts/Passport/_tutorials~/PassportInitialisation/metadata.json similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/PassportInitialisation/metadata.json rename to sample/Assets/Scripts/Passport/_tutorials~/PassportInitialisation/metadata.json diff --git a/sample/Assets/Scripts/Passport/_tutorials/PassportInitialisation/tutorial.md b/sample/Assets/Scripts/Passport/_tutorials~/PassportInitialisation/tutorial.md similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/PassportInitialisation/tutorial.md rename to sample/Assets/Scripts/Passport/_tutorials~/PassportInitialisation/tutorial.md diff --git a/sample/Assets/Scripts/Passport/_tutorials/SetCallTimeout/metadata.json b/sample/Assets/Scripts/Passport/_tutorials~/SetCallTimeout/metadata.json similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/SetCallTimeout/metadata.json rename to sample/Assets/Scripts/Passport/_tutorials~/SetCallTimeout/metadata.json diff --git a/sample/Assets/Scripts/Passport/_tutorials/SetCallTimeout/tutorial.md b/sample/Assets/Scripts/Passport/_tutorials~/SetCallTimeout/tutorial.md similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/SetCallTimeout/tutorial.md rename to sample/Assets/Scripts/Passport/_tutorials~/SetCallTimeout/tutorial.md diff --git a/sample/Assets/Scripts/Passport/_tutorials/ZkEvm/metadata.json b/sample/Assets/Scripts/Passport/_tutorials~/ZkEvm/metadata.json similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/ZkEvm/metadata.json rename to sample/Assets/Scripts/Passport/_tutorials~/ZkEvm/metadata.json diff --git a/sample/Assets/Scripts/Passport/_tutorials/ZkEvm/tutorial.md b/sample/Assets/Scripts/Passport/_tutorials~/ZkEvm/tutorial.md similarity index 100% rename from sample/Assets/Scripts/Passport/_tutorials/ZkEvm/tutorial.md rename to sample/Assets/Scripts/Passport/_tutorials~/ZkEvm/tutorial.md