final tips and comments

README.md

@@ -27,3 +27,12 @@ Site search is powered by [PageFind](https://pagefind.app/). Before deploy, a se
 Email addresses are Base64 encoded to prevent casual scraping.
 
 The site was not made with reuse in mind, but it hasn't been so hard. Just rip out the content files, rewrite nav.html and footer.html and change the base URL in config.toml.
+
+## Tips and notes
+
+1. Sometimes the script won't apply. This is due to the browser cache, run it in guest or incognito or clear cache
+2. Any pagefind related change/content change needs to run `yarn pagefind-dev` to load
+3. run `prettier docs package.json "{app,__{tests,mocks}__}/**/*.js" --write --single-quote --trailing-comma all` before you push
+4. run `yarn test` before push to the main branch to ensure proper deployment
+4. If you see expert, expertise, location, it is not related to this project
+5. The main folders: layouts, assets/js, contents and all the configs and yml(website building) files. 

layouts/_default/about.html

@@ -74,6 +74,7 @@ <h3 class="text-gray-800 text-lg font-bold">
       animatedElements.forEach((element) => {
         element.addEventListener("animationend", () => {
           // Remove the animation class after the animation ends
+          // the transform will be overwritten by the entering animation, so it get's removed and replaced with the hover animation
           element.classList.remove("enter-team-member");
         });
       });

layouts/_default/person.html

@@ -473,9 +473,10 @@ <h2 class="text-lg font-bold">Citations</h2>
       animation: slideInLeft 0.6s ease-out forwards;
     }
   </style>
+
+  <!-- the tool tip script -->
   <script src="https://unpkg.com/@popperjs/core@2"></script>
   <script src="https://unpkg.com/tippy.js@6"></script>
-
   <script>
     document.addEventListener("DOMContentLoaded", function () {
       tippy("#college", {

layouts/partials/contactus-box.html

@@ -1,4 +1,5 @@
 <!-- layouts/partials/modal.html -->
+<!-- the actual form sending function is not implemented, it's probably the problem on the google sheet side, app script -->
 <div
   x-show="showModal"
   x-transition:enter="transition ease-out duration-200"
@@ -86,6 +87,8 @@ <h3 class="text-lg font-medium leading-6 text-black">Contact Us</h3>
     </div>
   </div>
 </div>
+
+<!-- the form sending and copy email to clipboard script -->
 <script>
   function submitForm(event) {
     event.preventDefault();

layouts/partials/person-box.html

@@ -98,9 +98,11 @@
       </span>
     </p>
   {{ end }}
+
+
+  <!-- the tool tip script -->
   <script src="https://unpkg.com/@popperjs/core@2"></script>
   <script src="https://unpkg.com/tippy.js@6"></script>
-
   <script>
     document.addEventListener("DOMContentLoaded", function () {
       tippy("#researchArea", {

layouts/partials/search.html

@@ -197,9 +197,10 @@ <h3 class="truncate text-g-6" x-text="p.organization"></h3>
           class="mt-2 break-words font-serif text-sm italic text-gray [&_mark]:bg-green [&_mark]:p-[2px] [&_mark]:text-white"
           x-html="p.excerpt+'…'"
         ></p>
+
+        <!-- the tool tip script -->
         <script src="https://unpkg.com/@popperjs/core@2"></script>
         <script src="https://unpkg.com/tippy.js@6"></script>
-
         <script>
           document.addEventListener("DOMContentLoaded", function () {
             tippy("#researchArea", {

layouts/partials/svg.html

@@ -1,3 +1,4 @@
+<!-- When uploading svgs, please delete the build-in height width and fill/color propterties -->
 {{ $svgs := dict
   "check-svg" "@fontawesome/solid/check.svg"
   "close-svg" "@fontawesome/solid/circle-xmark.svg"