Added jsdocs to document code

themes/digital.gov/layouts/partials/core/glossary.html

@@ -1,3 +1,8 @@
+{{/* Display a sidebar of glossary terms populated by a json file used on guide pages
+  See example here by clicking on glossary button https://digital.gov/guides/hcd/discovery-concepts/
+*/}}
+
+
 <aside
   class="dg-glossary__container"
   aria-describedby="dg-glossary__result"

themes/digital.gov/src/js/summary-box.js

@@ -1,18 +1,26 @@
-// Guide Table of Contents
-// Replaces guidenav.js that used Hugo's .TableOfContents with Summary Box component — https://designsystem.digital.gov/components/summary-box/#package
-// Get all H2's and create a top of the page Table of Contents if shortcode is used on the markdown page
-
+/**
+ * Guide Table of Contents
+ * Replaces guidenav.js that used Hugo's .TableOfContents with USWDS summary-box — https://designsystem.digital.gov/components/summary-box/#package
+ * Get all H2's and create a top of the page Table of Contents if shortcode is used on the markdown page
+ */
 // eslint-disable-next-line func-names
 (function () {
   const guideSummary = document.querySelector(".dg-guide-summary");
 
   if (!guideSummary) return;
 
   const guideSummaryList = guideSummary.querySelector(".usa-list");
+  /**
+   * Return a list of h2's to display in the summary box
+   * and filter out h2's we do not want to show with the :not selector
+   */
   const pageHeaders = document.querySelectorAll(
     "h2:not(.usa-summary-box__heading, .dg-guide__content-header-title, .dg-glossary__header)"
   );
 
+  /**
+   * Populate the summary box with bulleted list of links created from the current page's h2's
+   */
   function createSummaryBox() {
     const summaryBoxFragment = document.createDocumentFragment();
     pageHeaders.forEach((link) => {