From 172ccf057a5429ca1c6293295a983176f9341e5d Mon Sep 17 00:00:00 2001 From: "alexandria.gomez" Date: Tue, 16 Sep 2025 11:26:47 -0400 Subject: [PATCH 01/13] add tables for documentation --- src/Gemfile.lock | 2 + src/_includes/components/aux_nav.html | 26 +- src/_includes/components/breadcrumbs.html | 110 ++++- src/_includes/components/children_nav.html | 98 +++- src/_includes/components/footer.html | 61 +-- src/_includes/components/header.html | 14 +- src/_includes/components/mermaid.html | 32 +- src/_includes/components/nav/children.html | 48 ++ src/_includes/components/nav/links.html | 53 +++ src/_includes/components/nav/pages.html | 23 + src/_includes/components/nav/sorted.html | 109 +++++ src/_includes/components/search_footer.html | 10 +- src/_includes/components/search_header.html | 18 +- src/_includes/components/sidebar.html | 100 ++-- src/_includes/components/site_nav.html | 72 +++ src/_includes/css/activation.scss.liquid | 439 ++++++++++++------ src/_includes/favicon.html | 38 +- src/_includes/fix_linenos.html | 32 +- src/_includes/footer_custom.html | 107 +---- src/_includes/head.html | 74 +-- src/_includes/head_custom.html | 6 - src/_includes/head_nav.html | 23 - src/_includes/header_custom.html | 52 --- src/_includes/icons/code_copy.html | 34 +- src/_includes/icons/document.html | 16 +- src/_includes/icons/expand.html | 13 +- src/_includes/icons/external_link.html | 17 +- src/_includes/icons/icons.html | 16 +- src/_includes/icons/link.html | 20 +- src/_includes/icons/menu.html | 17 +- src/_includes/icons/search.html | 16 +- src/_includes/js/custom.js | 50 -- src/_includes/js/gtm.js | 10 - src/_includes/nav.html | 74 --- src/_includes/sorted_pages.html | 56 --- src/_includes/title.html | 7 +- src/_layouts/default.html | 14 +- src/_layouts/minimal.html | 34 +- src/_sass/base.scss | 3 +- src/_sass/color_schemes/dark.scss | 8 +- src/_sass/color_schemes/legacy_light.scss | 208 +++++++++ src/_sass/color_schemes/lf-styles.scss | 2 +- src/_sass/color_schemes/light.scss | 7 +- src/_sass/content.scss | 6 - src/_sass/custom/custom.scss | 145 +----- src/_sass/labels.scss | 3 +- src/_sass/layout.scss | 112 +++-- src/_sass/navigation.scss | 53 +-- src/_sass/print.scss | 6 + src/_sass/support/_variables.scss | 15 +- src/_sass/support/mixins/_buttons.scss | 4 +- src/_sass/support/mixins/_typography.scss | 44 +- src/_sass/typography.scss | 1 + src/_sass/utilities/_colors.scss | 160 +++++++ src/_sass/vendor/OneDarkJekyll/syntax.scss | 63 +++ src/_sass/vendor/OneLightJekyll/syntax.scss | 65 +++ .../vendor/normalize.scss/normalize.scss | 14 +- src/assets/css/just-the-docs-head-nav.css | 24 + src/assets/images/large-image.jpg | Bin 0 -> 545267 bytes src/assets/images/small-image.jpg | Bin 0 -> 44128 bytes src/assets/js/just-the-docs.js | 77 ++- src/assets/js/zzzz-search-data.json | 1 + .../index.md | 4 +- .../api/repository-api-reference/index.md | 34 ++ .../long-operations/index.md | 139 ++++++ .../authenticating-with-selfhosted/index.md | 54 +++ .../repository-api-reference/server/index.md | 28 ++ .../installing-and-configuring}/index.md | 69 +-- .../server/selfhosted-connections/index.md | 39 ++ .../getting-started/guide_api-limits/index.md | 18 +- .../guide_long-operations-v1/index.md | 119 ----- .../guide_long-operations/index.md | 120 +---- .../guides/search/guide_search-v1/index.md | 302 ++++++------ .../guide_search-vs-simple-search-v1/index.md | 32 -- .../guide_search-vs-simple-search/index.md | 36 -- src/docs/guides/search/guide_search/index.md | 306 ++++++------ src/docs/guides/search/index.md | 27 +- 77 files changed, 2426 insertions(+), 1863 deletions(-) create mode 100644 src/_includes/components/nav/children.html create mode 100644 src/_includes/components/nav/links.html create mode 100644 src/_includes/components/nav/pages.html create mode 100644 src/_includes/components/nav/sorted.html create mode 100644 src/_includes/components/site_nav.html delete mode 100644 src/_includes/head_nav.html delete mode 100644 src/_includes/js/gtm.js delete mode 100644 src/_includes/nav.html delete mode 100644 src/_includes/sorted_pages.html create mode 100644 src/_sass/color_schemes/legacy_light.scss create mode 100644 src/assets/css/just-the-docs-head-nav.css create mode 100644 src/assets/images/large-image.jpg create mode 100644 src/assets/images/small-image.jpg create mode 100644 src/docs/api/repository-api-reference/long-operations/index.md create mode 100644 src/docs/api/repository-api-reference/server/authenticating-with-selfhosted/index.md create mode 100644 src/docs/api/repository-api-reference/server/index.md rename src/docs/api/{server => repository-api-reference/server/installing-and-configuring}/index.md (54%) create mode 100644 src/docs/api/repository-api-reference/server/selfhosted-connections/index.md delete mode 100644 src/docs/getting-started/guide_long-operations-v1/index.md delete mode 100644 src/docs/guides/search/guide_search-vs-simple-search-v1/index.md delete mode 100644 src/docs/guides/search/guide_search-vs-simple-search/index.md diff --git a/src/Gemfile.lock b/src/Gemfile.lock index 0a9300f..28acd22 100644 --- a/src/Gemfile.lock +++ b/src/Gemfile.lock @@ -128,6 +128,7 @@ GEM typhoeus (1.4.1) ethon (>= 0.9.0) unicode-display_width (2.6.0) + wdm (0.2.0) webrick (1.9.0) yell (2.2.2) zeitwerk (2.7.1) @@ -143,6 +144,7 @@ DEPENDENCIES jekyll (~> 4.2) jekyll-include-cache jekyll-redirect-from + wdm (>= 0.2.0) BUNDLED WITH 2.3.26 diff --git a/src/_includes/components/aux_nav.html b/src/_includes/components/aux_nav.html index 9cdd77c..f327da6 100644 --- a/src/_includes/components/aux_nav.html +++ b/src/_includes/components/aux_nav.html @@ -1,23 +1,15 @@ diff --git a/src/_includes/components/breadcrumbs.html b/src/_includes/components/breadcrumbs.html index 8caf89a..6bdcdad 100644 --- a/src/_includes/components/breadcrumbs.html +++ b/src/_includes/components/breadcrumbs.html @@ -1,30 +1,96 @@ -{%- comment -%} Include as: {%- include components/breadcrumbs.html -%} Depends -on: page, site. Results in: HTML for the breadcrumbs component. Overwrites: -pages_list, parent_page, grandparent_page. {%- endcomment -%} {%- if page.url != -"/" and page.parent -%} {%- assign pages_list = site[page.collection] | default: -site.html_pages | where_exp: "item", "item.title != nil" | where_exp: "item", -"item.has_children != nil" -%} {%- if page.grand_parent -%} {%- assign -parent_page = pages_list | where: "title", page.parent | where: "parent", -page.grand_parent | first -%} {%- assign grandparent_page = pages_list | where: -"title", page.grand_parent | first -%} {%- else -%} {%- assign parent_page = -pages_list | where: "title", page.parent | where_exp: "item", "item.parent == -nil" | first -%} {%- endif -%} +{%- comment -%} + Include as: {%- include components/breadcrumbs.html -%} + Depends on: page, site. + Includes: components/site_nav.html. + Results in: HTML for the breadcrumbs component. + Overwrites: + nav_list_link, site_nav, nav_list_simple, nav_list_link_class, nav_category, + nav_anchor_splits, nav_breadcrumbs, nav_split, nav_split_next, nav_split_test, + nav_breadcrumb_link, nav_list_end_less, nav_list_end_count, nav_end_index, nav_breadcrumb. +{%- endcomment -%} + +{%- if page.url != "/" and page.parent and page.title -%} + +{%- capture site_nav -%} +{%- include_cached components/site_nav.html all=true -%} +{%- endcapture -%} + +{%- capture nav_list_link -%} + +{%- endcapture -%} + +{%- capture nav_list_simple -%} +"s requires that number + of potential ancestors to be popped from the stack. + + The number of occurrences of a string in nav_split_next is computed by removing + them all, then dividing the resulting size difference by the length of the string. +{%- endcomment %} + +{%- assign nav_breadcrumbs = "" | split: "" -%} + +{%- for nav_split in nav_anchor_splits -%} +{%- unless forloop.last -%} + +{%- assign nav_split_next = nav_anchor_splits[forloop.index] | strip -%} + +{%- assign nav_split_test = + nav_split_next | remove_first: nav_list_simple | prepend: nav_list_simple -%} +{%- if nav_split_test == nav_split_next -%} + {%- assign nav_breadcrumb_link = + nav_split | split: "" | append: "" -%} + {%- assign nav_breadcrumbs = nav_breadcrumbs | push: nav_breadcrumb_link -%} +{%- endif -%} + +{%- if nav_split_next contains "" -%} + {%- assign nav_list_end_less = nav_split_next | remove: "" -%} + {%- assign nav_list_end_count = + nav_split_next.size | minus: nav_list_end_less.size | divided_by: 5 -%} + {% for nav_end_index in (1..nav_list_end_count) %} + {%- assign nav_breadcrumbs = nav_breadcrumbs | pop -%} + {%- endfor -%} +{%- endif -%} + +{%- endunless -%} +{%- endfor -%} +{% if site.nav_error_report %} +{{ nav_error_report }} +{% endif %} + {%- endif -%} diff --git a/src/_includes/components/children_nav.html b/src/_includes/components/children_nav.html index d0fe4c3..e0ba097 100644 --- a/src/_includes/components/children_nav.html +++ b/src/_includes/components/children_nav.html @@ -1,20 +1,90 @@ -{%- comment -%} Include as: {%- include components/children_nav.html -%} Depends -on: page, site. Results in: HTML for the children-navigation component. -Includes: sorted_pages.html toc_heading_custom.html Overwrites: child_pages. {%- -endcomment -%} {%- if page.has_children == true and page.has_toc != false -%} -{%- assign child_pages = site[page.collection] | default: site.html_pages | -where: "parent", page.title | where: "grand_parent", page.parent -%} {%- include -sorted_pages.html pages = child_pages -%} {%- if page.child_nav_order == 'desc' -or page.child_nav_order == 'reversed' -%} {%- assign sorted_pages = sorted_pages -| reverse -%} {%- endif -%} {%- endif -%} - -
+{%- comment -%} + Include as: {%- include components/children_nav.html -%} + Depends on: page, site, nav_breadcrumbs. + Results in: HTML for the children-navigation component. + Includes: components/nav/sorted.html, toc_heading_custom.html. + Overwrites: + nav_ancestor_links, nav_top_node_titles, nav_child_candidates, nav_children, + nav_child, nav_child_ok, nav_child_ancestor, nav_sorted. +{%- endcomment -%} + +{%- comment -%} + Whether a page has any children is checked efficiently by inspecting the cached + site_nav. If the page has no children, nav_children is set to an empty array; + otherwise nav_children is left unset. (The site_nav is rendered the first time + it is included, and that may overwrite various variables.) +{%- endcomment -%} + +{%- if page.has_children == false -%} + {%- assign nav_children = "" | split: "" -%} +{%- else -%} + + {%- capture site_nav -%} + {%- include_cached components/site_nav.html all=true -%} + {%- endcapture -%} + + {%- assign nav_children = nil -%} + + {%- capture nav_list_link -%} + + {%- endcapture -%} + + {%- capture nav_list_simple -%} +