Updated documentation files

Signed-off-by: George Araújo <[email protected]>

Author: george-gca

BOOTSTRAP5_MIGRATION.md

@@ -1,13 +1,15 @@
 # Bootstrap 5 and Dependencies Update - Migration Guide
 
 ## Overview
+
 This document describes the comprehensive dependency update performed on the al-folio template, with a focus on the major Bootstrap 4 to Bootstrap 5 migration.
 
 ## Updated Dependencies
 
 ### Major Updates
 
 #### Bootstrap: v4.6.2 → v5.3.8 ⚠️ BREAKING CHANGES
+
 - **Files Updated:**
   - `assets/css/bootstrap.min.css`
   - `assets/css/bootstrap.min.css.map`
@@ -16,17 +18,20 @@ This document describes the comprehensive dependency update performed on the al-
 - **Breaking Changes:** See Bootstrap 5 Migration section below
 
 #### jQuery: v3.6.0 → v4.0.0 ⚠️ BREAKING CHANGES
+
 - Bootstrap 5 no longer requires jQuery
 - jQuery 4.0 has its own breaking changes
 - Consider removing jQuery if not used elsewhere
 
 #### MathJax: v3.2.2 → v4.1.0 ⚠️ BREAKING CHANGES
+
 - Major version update with potential API changes
 - Math rendering should be tested thoroughly
 
 ### Library Updates (CDN)
 
 #### Visualization Libraries
+
 - **chart.js:** v4.4.1 → v4.5.1
 - **d3:** v7.8.5 → v7.9.0
 - **echarts:** v5.5.0 → v6.0.0 ⚠️ MAJOR VERSION
@@ -37,15 +42,18 @@ This document describes the comprehensive dependency update performed on the al-
 - **vega-lite:** v5.16.3 → v6.4.2 ⚠️ MAJOR VERSION
 
 #### UI Libraries
+
 - **bootstrap-table:** v1.22.4 → v1.26.0
 - **diff2html:** v3.4.47 → v3.4.55
 - **highlightjs:** v11.9.0 → v11.11.1
 - **swiper:** v11.0.5 → v12.0.3 ⚠️ MAJOR VERSION
 
 ### npm Dependencies
+
 - **prettier:** ^3.8.0 → ^3.8.1
 
 ### Libraries Already at Latest Version (No Update)
+
 - imagesloaded: v5.0.0
 - img-comparison-slider: v8.0.6
 - leaflet: v1.9.4
@@ -65,34 +73,41 @@ This document describes the comprehensive dependency update performed on the al-
 All deprecated Bootstrap 4 utility classes have been updated to Bootstrap 5 equivalents:
 
 #### Margin Classes
+
 - `ml-*` → `ms-*` (margin-left → margin-start)
 - `mr-*` → `me-*` (margin-right → margin-end)
 
 #### Padding Classes
+
 - `pl-*` → `ps-*` (padding-left → padding-start)
 - `pr-*` → `pe-*` (padding-right → padding-end)
 
 #### Text Alignment
+
 - `text-left` → `text-start`
 - `text-right` → `text-end`
 
 #### Float Classes
+
 - `float-left` → `float-start`
 - `float-right` → `float-end`
 
 #### Dropdown Classes
+
 - `dropdown-menu-right` → `dropdown-menu-end`
 
 ### Data Attribute Changes
 
 All Bootstrap data attributes have been updated to use the `data-bs-*` prefix:
+
 - `data-toggle` → `data-bs-toggle`
 - `data-target` → `data-bs-target`
 - `data-dismiss` → `data-bs-dismiss`
 
 ### Files Modified
 
 #### Template Files
+
 - `_includes/header.liquid` - Updated navbar, dropdown, and collapse attributes
 - `_layouts/cv.liquid` - Updated table padding classes and float classes
 - `_includes/cv/*.liquid` - Updated margin classes in all CV sections
@@ -103,13 +118,16 @@ All Bootstrap data attributes have been updated to use the `data-bs-*` prefix:
 - `_pages/blog.md` - Updated float classes
 
 #### JavaScript Files
+
 - `assets/js/tooltips-setup.js` - Updated tooltip selector to `data-bs-toggle`
 - `assets/js/common.js` - Updated scrollspy and popover initialization for Bootstrap 5
 
 ### JavaScript API Changes
 
 #### ScrollSpy Initialization
+
 **Before (Bootstrap 4):**
+
 ```javascript
 $("body").scrollspy({
   target: navSelector,
@@ -118,6 +136,7 @@ $("body").scrollspy({
 ```
 
 **After (Bootstrap 5):**
+
 ```javascript
 const scrollSpy = new bootstrap.ScrollSpy(document.body, {
   target: navSelector,
@@ -126,13 +145,16 @@ const scrollSpy = new bootstrap.ScrollSpy(document.body, {
 ```
 
 #### Tooltip and Popover Selectors
+
 **Before:**
+
 ```javascript
 $('[data-toggle="tooltip"]').tooltip();
 $('[data-toggle="popover"]').popover();
 ```
 
 **After:**
+
 ```javascript
 $('[data-bs-toggle="tooltip"]').tooltip();
 $('[data-bs-toggle="popover"]').popover();
@@ -141,16 +163,19 @@ $('[data-bs-toggle="popover"]').popover();
 ## Known Issues and Considerations
 
 ### 1. Material Design Bootstrap (MDB) Compatibility
+
 - MDB v4.20.0 was built for Bootstrap 4
 - May have compatibility issues with Bootstrap 5
 - Testing required for any pages using MDB components
 - Consider updating to MDB 5 in the future if issues arise
 
 ### 2. Bootstrap TOC Compatibility
+
 - bootstrap-toc v1.0.1 should work with Bootstrap 5
 - Needs testing on pages with table of contents
 
 ### 3. jQuery Dependency
+
 - Bootstrap 5 no longer requires jQuery
 - al-folio still uses jQuery for:
   - bootstrap-toc
@@ -159,12 +184,15 @@ $('[data-bs-toggle="popover"]').popover();
 - jQuery 4.0.0 included but could be removed if refactored to vanilla JS
 
 ### 4. SRI Integrity Hashes
+
 - All integrity hashes have been updated for new library versions
 - These are placeholder hashes and should be regenerated if CDN usage changes
 - Verify hashes at https://www.srihash.org/ when deploying
 
 ### 5. Major Version Updates Requiring Testing
+
 The following libraries had major version updates and may have breaking changes:
+
 - **echarts:** v5 → v6
 - **mermaid:** v10 → v11
 - **vega ecosystem:** v5/v6 → v6/v7
@@ -178,12 +206,14 @@ Pages using these libraries should be tested thoroughly.
 After applying these updates, test the following:
 
 ### Core Functionality
+
 - [ ] Site builds without errors
 - [ ] All pages load correctly
 - [ ] No console errors in browser
 - [ ] Responsive layout works on mobile/tablet/desktop
 
 ### Bootstrap 5 Features
+
 - [ ] Navigation menu and dropdowns work
 - [ ] Navbar collapse/expand on mobile
 - [ ] Tooltips appear correctly
@@ -192,6 +222,7 @@ After applying these updates, test the following:
 - [ ] Scrollspy updates active navigation
 
 ### Page-Specific Features
+
 - [ ] About page renders correctly
 - [ ] Blog posts display properly
 - [ ] Publications page with BibTeX works
@@ -201,6 +232,7 @@ After applying these updates, test the following:
 - [ ] Dark mode toggle works
 
 ### Visualization Libraries
+
 - [ ] Chart.js visualizations render
 - [ ] Mermaid diagrams display
 - [ ] Plotly charts work
@@ -209,6 +241,7 @@ After applying these updates, test the following:
 - [ ] D3 visualizations work
 
 ### Math and Code
+
 - [ ] MathJax renders equations correctly
 - [ ] Code highlighting works (highlight.js)
 - [ ] Jupyter notebooks display
@@ -218,6 +251,7 @@ After applying these updates, test the following:
 If you encounter critical issues after this update:
 
 1. **Revert Bootstrap files:**
+
    ```bash
    git checkout HEAD~1 -- assets/css/bootstrap.min.css
    git checkout HEAD~1 -- assets/css/bootstrap.min.css.map
@@ -226,6 +260,7 @@ If you encounter critical issues after this update:
    ```
 
 2. **Revert configuration and template changes:**
+
    ```bash
    git checkout HEAD~1 -- _config.yml
    git checkout HEAD~1 -- _includes/