From 5c2257b7a8eb7f71c033275b23af6803139a9142 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:27:52 +0200 Subject: [PATCH 01/17] Refactored linkifyAnchors function This update refactors the `linkifyAnchors` function to use arrow function syntax and the `Array.from()` method to convert the result of `getElementsByTagName()` to an array. The update also uses template literals to clean up the anchor.href assignment. Additionally, `var` declarations are replaced with `const` or `let`. --- docs/_includes/anchor_links.html | 61 ++++++++++++++++++-------------- 1 file changed, 34 insertions(+), 27 deletions(-) diff --git a/docs/_includes/anchor_links.html b/docs/_includes/anchor_links.html index c584ce5d7c8..77e7782ba62 100644 --- a/docs/_includes/anchor_links.html +++ b/docs/_includes/anchor_links.html @@ -1,33 +1,40 @@ + + From eaef09c3f57b3868890ffa23022861e479356ad5 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:33:03 +0200 Subject: [PATCH 02/17] Updated syntax for navigation menu Revised liquid syntax for navigation menu with additional variables, reducing lines of code. --- docs/_includes/docs_contents.html | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/_includes/docs_contents.html b/docs/_includes/docs_contents.html index 931500a90b2..8b7b19dacab 100644 --- a/docs/_includes/docs_contents.html +++ b/docs/_includes/docs_contents.html @@ -1,14 +1,17 @@
From fce0a979af2f0c2a283566d8eda382cc44d25c89 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:37:12 +0200 Subject: [PATCH 03/17] Refactor navigation for docs on mobile The change involves removing unnecessary hyphen in the `for` loops, but otherwise retains the original functionality of the navigation. --- docs/_includes/docs_contents_mobile.html | 29 +++++++++++++++--------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/_includes/docs_contents_mobile.html b/docs/_includes/docs_contents_mobile.html index 6574b6a940b..7ce5e3ede17 100644 --- a/docs/_includes/docs_contents_mobile.html +++ b/docs/_includes/docs_contents_mobile.html @@ -1,15 +1,22 @@
- - {% for section in site.data.docs_nav -%} - - {%- for item in section.docs -%} - {% assign p = site.docs | where: "url", item.link | first %} - - {%- endfor %} - - {% endfor -%} + {% for section in site.data.docs_nav %} + + {%- for item in section.docs -%} + {% assign page = site.docs | where: "url", item.link | first %} + + {%- endfor %} + + {% endfor %}
+ + From 7d1b51dfb173741d83a3ca3cd2cc793b3031f351 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:40:33 +0200 Subject: [PATCH 04/17] + ARIA label to `.docs-nav-mobile` --- docs/_includes/docs_contents_mobile.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_includes/docs_contents_mobile.html b/docs/_includes/docs_contents_mobile.html index 7ce5e3ede17..97fffc2b889 100644 --- a/docs/_includes/docs_contents_mobile.html +++ b/docs/_includes/docs_contents_mobile.html @@ -1,5 +1,5 @@
- {% for section in site.data.docs_nav %} @@ -19,4 +19,4 @@ const url = select.value; url && (window.location.href = url); }; - + \ No newline at end of file From 41841b31a9643703f449e55429ae15e6cadf7a38 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:41:48 +0200 Subject: [PATCH 05/17] Update anchor_links.html - Added aria-hidden="true" to the i tag to indicate that it doesn't provide any important information for assistive technologies --- docs/_includes/anchor_links.html | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/_includes/anchor_links.html b/docs/_includes/anchor_links.html index 77e7782ba62..495ce3a941a 100644 --- a/docs/_includes/anchor_links.html +++ b/docs/_includes/anchor_links.html @@ -4,7 +4,7 @@ const anchor = document.createElement("a"); anchor.className = "header-link"; anchor.href = `#${id}`; - anchor.innerHTML = `Permalink`; + anchor.innerHTML = `Permalink`; anchor.title = "Permalink"; return anchor; }; @@ -36,5 +36,3 @@ } }; - - From 8a75c14fccc7d20e7399a4eb56ce96fe7078d3d0 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:45:15 +0200 Subject: [PATCH 06/17] aria-current + --- docs/_includes/mobile-nav-items.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/_includes/mobile-nav-items.html b/docs/_includes/mobile-nav-items.html index 5dd9b86d206..ca337ba378d 100644 --- a/docs/_includes/mobile-nav-items.html +++ b/docs/_includes/mobile-nav-items.html @@ -3,12 +3,12 @@ {% if p.show_on_mobile -%}
  • {{ p.title }}
  • {% endif -%} {% endfor -%} -
  • GitHub
  • - +
  • GitHub
  • + \ No newline at end of file From d8a8d3eac3c8f1a894b91fa55775ae50276b27c7 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 12:55:12 +0200 Subject: [PATCH 07/17] en-US to en The language attribute "en-US" is not necessary because "en" is sufficient to indicate the document's language as English, and any regional variations can be conveyed through other means such as regional dialect or locale-specific settings. --- docs/_includes/top.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_includes/top.html b/docs/_includes/top.html index c0e203c33f4..653d8f1c446 100644 --- a/docs/_includes/top.html +++ b/docs/_includes/top.html @@ -1,5 +1,5 @@ - + From 7cf33d74c0dcf8c02029b08ac6ca11c96fc5e226 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 13:00:19 +0200 Subject: [PATCH 08/17] lowercase HTML in doctype Both and are valid ways to declare the document type for HTML5 documents. However, it's recommended to use --- docs/_includes/top.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_includes/top.html b/docs/_includes/top.html index 653d8f1c446..0868d0cf43d 100644 --- a/docs/_includes/top.html +++ b/docs/_includes/top.html @@ -1,4 +1,4 @@ - + From 86dd50fbf26cb3805eda9aca2f9ecfd8fa8309d7 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 13:01:32 +0200 Subject: [PATCH 09/17] search ARIA --- docs/_includes/search/input.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_includes/search/input.html b/docs/_includes/search/input.html index 729f5cabdfd..65015ee406c 100644 --- a/docs/_includes/search/input.html +++ b/docs/_includes/search/input.html @@ -1 +1 @@ - + \ No newline at end of file From 7e6e017eba3c6ba0a57c459bd105f7b62099aa3d Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 13:04:56 +0200 Subject: [PATCH 10/17] scripts.html, defer Added defer attribute to script for faster page load. --- docs/_includes/search/script.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_includes/search/script.html b/docs/_includes/search/script.html index dca756d7709..7ddd1280fed 100644 --- a/docs/_includes/search/script.html +++ b/docs/_includes/search/script.html @@ -1,9 +1,9 @@ - + From f99d0d812f6c373996ce5a66b3bc8176e64123bd Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 13:05:45 +0200 Subject: [PATCH 11/17] moved `navigateToUrl` to footer - added accessibility to mobile navigation - moved navigateToUrl to footer --- docs/_includes/docs_contents_mobile.html | 9 +-------- docs/_includes/news_contents_mobile.html | 4 ++-- docs/_includes/tutorials_contents_mobile.html | 18 +++++++++--------- docs/_layouts/default.html | 11 +++++++++++ 4 files changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/_includes/docs_contents_mobile.html b/docs/_includes/docs_contents_mobile.html index 97fffc2b889..a8c2b3b6d6a 100644 --- a/docs/_includes/docs_contents_mobile.html +++ b/docs/_includes/docs_contents_mobile.html @@ -12,11 +12,4 @@
    {% endfor %} -
    - - \ No newline at end of file +
    \ No newline at end of file diff --git a/docs/_includes/news_contents_mobile.html b/docs/_includes/news_contents_mobile.html index 84972788ac5..6f6a98e4734 100644 --- a/docs/_includes/news_contents_mobile.html +++ b/docs/_includes/news_contents_mobile.html @@ -1,5 +1,5 @@
    - @@ -8,4 +8,4 @@ {% endfor -%} -
    + \ No newline at end of file diff --git a/docs/_includes/tutorials_contents_mobile.html b/docs/_includes/tutorials_contents_mobile.html index 080788d5fe4..4a8a9478382 100644 --- a/docs/_includes/tutorials_contents_mobile.html +++ b/docs/_includes/tutorials_contents_mobile.html @@ -1,14 +1,14 @@
    - {% for section in site.data.tutorials -%} - - {% for item in section.tutorials -%} - {% assign item_url = item | prepend:"/tutorials/" | append:"/" -%} - {% assign tutorial = site.tutorials | where: "url", item_url | first -%} - - {% endfor -%} - + + {% for item in section.tutorials -%} + {% assign item_url = item | prepend:"/tutorials/" | append:"/" -%} + {% assign tutorial = site.tutorials | where: "url", item_url | first -%} + + {% endfor -%} + {% endfor -%} -
    + \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 9234c13c754..fb30f981d0a 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -9,5 +9,16 @@ {%- include anchor_links.html -%} {%- include analytics.html -%} {%- include search/script.html -%} + + From 6947c5c79bc4e833a11b0538dcc2376dc336ef0c Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 13:10:35 +0200 Subject: [PATCH 12/17] structured data schema for news articles --- docs/_layouts/news_item.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_layouts/news_item.html b/docs/_layouts/news_item.html index 5b0960e97b6..7be7bf76bc9 100644 --- a/docs/_layouts/news_item.html +++ b/docs/_layouts/news_item.html @@ -2,8 +2,8 @@ layout: news --- -
    -

    + From ae27780f162cccfa2d4bd5517cf1edfacc09d5ed Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 13:15:46 +0200 Subject: [PATCH 13/17] structured data schema for news articles --- docs/_includes/news_item.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_includes/news_item.html b/docs/_includes/news_item.html index 51bc9cdff1f..6529a5f7a6a 100644 --- a/docs/_includes/news_item.html +++ b/docs/_includes/news_item.html @@ -1,5 +1,5 @@ -
    -

    + From 3f604f82065a07b8f2c37c2895610e55be040107 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Sat, 8 Apr 2023 13:16:23 +0200 Subject: [PATCH 14/17] structured data schema for news articles --- docs/_includes/news_item_archive.html | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/_includes/news_item_archive.html b/docs/_includes/news_item_archive.html index bccf6523d84..6b72e8a1cb4 100644 --- a/docs/_includes/news_item_archive.html +++ b/docs/_includes/news_item_archive.html @@ -1,4 +1,4 @@ -
    +
    From 5a927faa12e873de8b2d08ff3c39fbf841d8b6a7 Mon Sep 17 00:00:00 2001 From: Daniel Haim <2808046+danielhaim1@users.noreply.github.com> Date: Fri, 5 Jan 2024 18:21:04 +0100 Subject: [PATCH 15/17] Updated Comment Style and Fixed Quotation Marks in news_item_archive.html - Converted inline comments from single-line (//) to block style (/* */). - Amended double quotation marks in news_item_archive.html to rectify an error. --- docs/_includes/anchor_links.html | 16 ++++++++-------- docs/_includes/news_item_archive.html | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/_includes/anchor_links.html b/docs/_includes/anchor_links.html index 495ce3a941a..1bea56bf082 100644 --- a/docs/_includes/anchor_links.html +++ b/docs/_includes/anchor_links.html @@ -1,5 +1,5 @@