Fix file path comments

Author: perguth

README.md

@@ -1,4 +1,4 @@
-// README.md
+<!-- README.md -->
 # Thingylabs Performance Initiative
 
 ![Thingylabs GmbH Logo](https://www.thingylabs.io/logo-with-text.png "Thingylabs GmbH Logo")

add-path-comments.ts add-path.ts

@@ -12,7 +12,7 @@ async function addPathComments(rootDir: string) {
   })) {
     const filePath = entry.path;
     const relPath = relative(resolvedRoot, filePath);
-    const comment = `// ${relPath}\n`;
+    const comment = `<!-- ${relPath} -->\n`;
 
     try {
       const content = await Deno.readTextFile(filePath);
@@ -23,7 +23,7 @@ async function addPathComments(rootDir: string) {
       }
 
       const lines = content.split('\n');
-      while (lines.length > 0 && (lines[0].trim() === '' || lines[0].trim().startsWith('//'))) {
+      while (lines.length > 0 && (lines[0].trim() === '' || lines[0].trim().startsWith('<!--'))) {
         lines.shift();
       }
 
@@ -33,7 +33,7 @@ async function addPathComments(rootDir: string) {
       await Deno.writeTextFile(filePath, newContent);
       console.log(`Updated comment in ${relPath}`);
     } catch (err) {
-      const error = err as Error
+      const error = err as Error;
       console.error(`Error processing ${relPath}: ${error.message}`);
     }
   }
@@ -45,7 +45,7 @@ if (import.meta.main) {
     await addPathComments(rootDir);
     console.log('Finished adding file path comments');
   } catch (err) {
-    const error = err as Error
+    const error = err as Error;
     console.error('Error:', error.message);
     Deno.exit(1);
   }

deno.json

@@ -3,6 +3,6 @@
       "lib": ["deno.ns", "deno.window"]
     },
     "tasks": {
-      "add-path": "deno run --allow-read --allow-write add-path-comments.ts"
+      "add-path": "deno run --allow-read --allow-write add-path.ts"
     }
   }

docs/s1-consent-form.md

@@ -1,4 +1,4 @@
-// docs/s1-consent-form.md
+<!-- docs/s1-consent-form.md -->
 # Consent Form
 
 ## Overview

docs/s1-facilitator-guide.md

@@ -1,4 +1,4 @@
-// docs/s1-facilitator-guide.md
+<!-- docs/s1-facilitator-guide.md -->
 # Thingylabs Performance Initiative Consent Form
 
 ## Consent and Disclaimer for Thingylabs GmbH Employees

docs/s1-outline.md

@@ -1,4 +1,4 @@
-// docs/s1-outline.md
+<!-- docs/s1-outline.md -->
 # Thingylabs Performance Initiative Study 1 Outline
 
 ## Overview

docs/s1-participant-guide.md

@@ -1,4 +1,4 @@
-// docs/s1-participant-guide.md
+<!-- docs/s1-participant-guide.md -->
 # Thingylabs Study 1 Weekly Sheet
 
 ## Welcome

docs/s1-protocol.md

@@ -1,4 +1,4 @@
-// docs/s1-protocol.md
+<!-- docs/s1-protocol.md -->
 # Thingylabs Performance Initiative Study 1 Protocol
 
 ## Overview

gdpr-compliance.md

@@ -1,4 +1,4 @@
-// gdpr-compliance.md
+<!-- gdpr-compliance.md -->
 # GDPR Compliance
 
 ## Overview

ownership-and-licensing.md

@@ -1,4 +1,3 @@
-// ownership-and-licensing.md
 <!-- ownership-and-licensing.md -->
 # Ownership and Licensing
 

surveys/s1-daily-tracker.m.md

@@ -1,4 +1,4 @@
-// surveys/s1-daily-tracker.m.md
+<!-- surveys/s1-daily-tracker.m.md -->
 ### Monday
 | Substance                  | Taken Today? | Custom Dose (e.g., pills, drops) |
 |----------------------------|---------------|----------------------------------|

surveys/s1-entry-survey.md

@@ -1,4 +1,4 @@
-// surveys/s1-entry-survey.md
+<!-- surveys/s1-entry-survey.md -->
 # Thingylabs Performance Initiative 1-Entry Survey
 
 ## Instructions for Use