fix: Search function and updated the links (#125)

Giaccomole · web-flow · commit 5c581778ab73 · 2025-09-22T11:26:39.000+02:00
* fix: search functionality for GitHub Pages search

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: update links and callout context in documentation

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: correct image path in documentation

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: remove empty FAQs page

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: remove FAQs section from main menu and navigation

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: remove FAQs section from mainSections in params.toml

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: remove Others section from navigation and preserve content

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: update tools link in index.html to point to the correct documentation path

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: update COVESA logo image path to the correct location

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

* fix: update links in documentation to use the correct path prefix

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;

---------

Signed-off-by: Orhun Ucak &lt;orhunucak@gmail.com&gt;
diff --git a/.gitignore b/.gitignore
@@ -14,6 +14,8 @@ yarn-error.log*
 public/
 .hugo_build.lock
 hugo_stats.json
+resources/_gen/
+docs-gen/resources/_gen/
 
 # Local configuration files
 .envrc
diff --git a/docs-gen/config/_default/menus/menus.en.toml b/docs-gen/config/_default/menus/menus.en.toml
@@ -10,18 +10,6 @@
   url = "examples/"
   weight = 20
 
-[[main]]
-  name = "FAQs"
-  identifier = "faqs"
-  url = "faqs/"
-  weight = 30
-
-[[main]]
-  name = "Others"
-  identifier = "others"
-  url = "others/"
-  weight = 40
-
 # Docs submenu items
 [[docs]]
   name = "Approach Overview"
diff --git a/docs-gen/config/_default/params.toml b/docs-gen/config/_default/params.toml
@@ -4,7 +4,7 @@ description = "S2DM - Signal to Data Model documentation"
 images = ["preview.png"]
 
 # mainSections
-mainSections = ["approach-overview", "data-modeling-guideline", "tools", "examples", "faqs", "others"]
+mainSections = ["approach-overview", "data-modeling-guideline", "tools", "examples"]
 # Doks (@hyas/doks-core)
 [doks]
   # Color mode
@@ -40,7 +40,7 @@ mainSections = ["approach-overview", "data-modeling-guideline", "tools", "exampl
   bootstrapJavascript = false # false (default) or true
 
   # Nav
-  sectionNav = ["docs", "examples", "faqs", "others"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
+  sectionNav = ["docs", "examples"] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"])
   toTopButton = false # false (default) or true
   breadcrumbTrail = true # false (default) or true
   headlineHash = true # true (default) or false
diff --git a/docs-gen/config/production/hugo.toml b/docs-gen/config/production/hugo.toml
@@ -1,7 +1,7 @@
 # Overrides for production environment
-baseURL = "https://giaccomole.github.io/s2dm/"
+baseURL = "/s2dm/"
 relativeURLs = false
-canonifyURLs = true
+canonifyURLs = false
 disableLiveReload = true
 enableRobotsTXT = true
 
diff --git a/docs-gen/content-archive/Others/approach_primer.md b/docs-gen/content-archive/Others/approach_primer.md
@@ -43,10 +43,10 @@ The reference mapping between the Vehicle Signal Specification (VSS) and this S2
 | **Support for cross-domain references** | Multiple cross-referenced domains are supported natively by the language (useful for contextual data). |
 | **Community & Tools** | Data model can be used in multiple up-to-date public tools. Modeling approach is based on a language that is already established in the open community. |
 
-![Goal](/images/vss-limits-criteria.jpg)
+![Goal](/s2dm/images/vss-limits-criteria.jpg)
 #### Goal
 - To minimize the effort needed to develop, extend, and maintain vehicle-related semantic data models.
-![Goal](/images/current-vs-desired.jpg)
+![Goal](/s2dm/images/current-vs-desired.jpg)
 #### Artifact
 - A guideline on how to model vehicle-related data with proper semantics and good practices.
 
@@ -64,7 +64,7 @@ In the case that no existing data matches his needs, simple steps must allow the
 To that end, such a process is proposed with the following ideas:
 
 
-![General flow](/images/general-flow.jpg)
+![General flow](/s2dm/images/general-flow.jpg)
 
 ### Idea (1): Maintain Entity and Property sets
 In an application, most of the value is centered around what one can read or write.
diff --git a/docs-gen/content-archive/Others/basic_principle.md b/docs-gen/content-archive/Others/basic_principle.md
diff --git a/docs-gen/content/_index.md b/docs-gen/content/_index.md
@@ -7,27 +7,27 @@ The _Simplified Semantic Data Modeling_ (`S2DM`) is an approach for modeling dat
 It is **_simple_** in the sense that any _Subject Matter Expert_ (SME) could contribute to a controlled vocabulary with minimal data modeling expertise.
 Likewise, it is **_semantic_** in the sense that it specifies meaningful data structures, their cross-domain relationships, and arbitrary classification schemes.
 
-{{< callout type="note" >}}
+{{< callout context="note">}}
 Bear in mind the word _**Simplified**_ in the name.
 This approach aims to foster the adoption of (some) good data modeling practices.
 It does not intend to re-invent or replace long-standing standards, such as those of the [Semantic Web](https://www.w3.org/2001/sw/wiki/Main_Page).
 Therefore, it does not incorporate advanced reasoning capabilities or comprehensive ontologies typically associated with traditional semantic data modeling.
 {{< /callout >}}
 
 <div class="w-100 my-4">
-  <img src="/images/s2dm_role.png" alt="S2DM Role Overview" class="img-fluid w-100" style="max-width: 100%; height: auto;">
+  <img src="/s2dm/images/s2dm_role.png" alt="S2DM Role Overview" class="img-fluid w-100" style="max-width: 100%; height: auto;">
 </div>
 
 The figure above ilustrates the role of the `S2DM` approach.
 One can distinghish three areas:
 the re-use of existing resources (left), the artifacts offered by `S2DM` (center), and the resulting domain data model created and maintained with `S2DM` artifacts (right).
 
 ### Getting started
-* Get a basic understanding of the [S2DM approach](/approach-overview).
-* Model your domain following the [S2DM data modeling guideline](/data-modeling-guideline).
-* Maintain your domain model with the support of the provided [S2DM tools](/tools).
+* Get a basic understanding of the [S2DM approach](/s2dm/docs/approach-overview).
+* Model your domain following the [S2DM data modeling guideline](/s2dm/docs/data-modeling-guideline).
+* Maintain your domain model with the support of the provided [S2DM tools](/s2dm/docs/tools).
 
-{{< callout type="tip" >}}
+{{< callout context="tip" >}}
 `S2DM` artifacts are based on the following existing resources. Getting familiar with them is recommended.
 
 - **Modeling languages and vocabularies**
@@ -37,5 +37,5 @@ the re-use of existing resources (left), the artifacts offered by `S2DM` (center
 - **Tools**
     - [rdflib](https://rdflib.readthedocs.io): For working with RDF data in Python (e.g., `SKOS`).
     - [graphql-core](https://graphql-core-3.readthedocs.io): For working with `GraphQL` schemas in Python (e.g., `SDL`).
-    - [Others](https://github.com/COVESA/s2dm/blob/main/pyproject.toml)
+    - [Additional dependencies](https://github.com/COVESA/s2dm/blob/main/pyproject.toml)
 {{< /callout >}}
diff --git a/docs-gen/content/docs/_index.md b/docs-gen/content/docs/_index.md
@@ -12,8 +12,8 @@ Welcome to the complete documentation for the **Simplified Semantic Data Modelin
 
 The documentation is structured to guide you through understanding, implementing, and using S2DM:
 
-- **[Approach Overview](/docs/approach-overview/)** - Learn the fundamental concepts and principles of S2DM
-- **[Data Modeling Guideline](/docs/data-modeling-guideline/)** - Step-by-step guide to modeling your domain with S2DM
-- **[Tools](/docs/tools/)** - Available tools and utilities to support your S2DM implementation
+- **[Approach Overview](/s2dm/docs/approach-overview/)** - Learn the fundamental concepts and principles of S2DM
+- **[Data Modeling Guideline](/s2dm/docs/data-modeling-guideline/)** - Step-by-step guide to modeling your domain with S2DM
+- **[Tools](/s2dm/docs/tools/)** - Available tools and utilities to support your S2DM implementation
 
 Each section contains detailed information to help you effectively use the S2DM approach for your data modeling needs.
diff --git a/docs-gen/content/docs/approach-overview/_index.md b/docs-gen/content/docs/approach-overview/_index.md
@@ -3,7 +3,7 @@ title: Approach overview
 weight: 10
 ---
 
-![Fig:s2dm_role](/images/s2dm_overview.png)
+![Fig:s2dm_role](/s2dm/images/s2dm_overview.png)
 The design of `S2DM` can be summarized in these parts:
 
 1. [Objects & Fields](objects-and-fields/)
diff --git a/docs-gen/content/docs/approach-overview/capabilities.md b/docs-gen/content/docs/approach-overview/capabilities.md
@@ -4,6 +4,6 @@ weight: 60
 chapter: false
 ---
 
-![Frame 6: Capabilities](/images/Frame%206.png)
+![Frame 6: Capabilities](/s2dm/images/Frame%206.png)
 
 Under construction...
diff --git a/docs-gen/content/docs/approach-overview/concept-uris.md b/docs-gen/content/docs/approach-overview/concept-uris.md
@@ -4,6 +4,6 @@ weight: 20
 chapter: false
 ---
 
-![Frame 2: Concept URIs](/images/Frame%202.png)
+![Frame 2: Concept URIs](/s2dm/images/Frame%202.png)
 
 Under construction...
diff --git a/docs-gen/content/docs/approach-overview/multi-hierarchies.md b/docs-gen/content/docs/approach-overview/multi-hierarchies.md
@@ -4,6 +4,6 @@ weight: 30
 chapter: false
 ---
 
-![Frame 3: Multi hierarchies](/images/Frame%203.png)
+![Frame 3: Multi hierarchies](/s2dm/images/Frame%203.png)
 
 Under construction...
diff --git a/docs-gen/content/docs/approach-overview/objects-and-properties.md b/docs-gen/content/docs/approach-overview/objects-and-properties.md
@@ -4,6 +4,6 @@ weight: 10
 chapter: false
 ---
 
-![Frame 1: Objects & Fields](/images/Frame%201.png)
+![Frame 1: Objects & Fields](/s2dm/images/Frame%201.png)
 
 Under construction...
diff --git a/docs-gen/content/docs/approach-overview/spec-registry.md b/docs-gen/content/docs/approach-overview/spec-registry.md
@@ -4,6 +4,6 @@ weight: 50
 chapter: false
 ---
 
-![Frame 5: Specification registry](/images/Frame%205.png)
+![Frame 5: Specification registry](/s2dm/images/Frame%205.png)
 
 Under construction...
diff --git a/docs-gen/content/docs/approach-overview/variant-ids.md b/docs-gen/content/docs/approach-overview/variant-ids.md
@@ -4,6 +4,6 @@ weight: 40
 chapter: false
 ---
 
-![Frame 4: Variant IDs](/images/Frame%204.png)
+![Frame 4: Variant IDs](/s2dm/images/Frame%204.png)
 
 Under construction..
diff --git a/docs-gen/content/docs/data-modeling-guideline/how-to.md b/docs-gen/content/docs/data-modeling-guideline/how-to.md
@@ -17,8 +17,10 @@ type MyObject {
 ```
 
 ## Modeling Guide
-> **NOTE:** This document explains how to contribute to an specific model (new or existing).
-If you want to contribute to the data modeling approach itself, then see the [Contributing Guide](/guides/contributing/) instead.
+{{< callout context="note" >}}
+This document explains how to contribute to a specific model (new or existing).
+If you want to contribute to the data modeling approach itself, see the [Contributing Guide](/guides/contributing/) instead.
+{{< /callout >}}
 
 > TODO: Work in progress...
 
diff --git a/docs-gen/content/docs/data-modeling-guideline/pre-defined-elements.md b/docs-gen/content/docs/data-modeling-guideline/pre-defined-elements.md
@@ -4,7 +4,7 @@ weight: 10
 chapter: false
 ---
 
-![fig:s2dm_pre_defined_elements](/images/s2dm_pre_def_elements.png)
+![fig:s2dm_pre_defined_elements](/s2dm/images/s2dm_pre_def_elements.png)
 
 ### Units
 Units are represented as enum values. For example:
@@ -17,10 +17,11 @@ enum VelocityUnitEnum {
 The name of the enum itself refers to the quantity kind (e.g., `Velocity`).
 A set of commonly used units is provided in the file [`unit_enums.graphql`](https://github.com/COVESA/s2dm/blob/main/src/s2dm/spec/unit_enums.graphql).
 
-> [!NOTE]
-> [It is planned](https://github.com/COVESA/s2dm/issues/43) to adopt and reuse an existing standard data model for units.
-> At the moment, the units file is inspired by [COVESA VSS Units file](https://github.com/COVESA/vehicle_signal_specification/blob/main/spec/units.md).
-> The tentative model that will be used in the future is the [QUDT units](http://www.qudt.org/doc/DOC_VOCAB-UNITS-ALL.html).
+{{< callout context="note" >}}
+It is planned to adopt and reuse an existing standard data model for units. See [issue #43](https://github.com/COVESA/s2dm/issues/43) for details.
+Currently, the units file is inspired by the [COVESA VSS Units file](https://github.com/COVESA/vehicle_signal_specification/blob/main/spec/units.md).
+The tentative model for future use is [QUDT units](http://www.qudt.org/doc/DOC_VOCAB-UNITS-ALL.html).
+{{< /callout >}}
 
 
 ### Custom scalars
diff --git a/docs-gen/content/faqs/_index.md b/docs-gen/content/faqs/_index.md
diff --git a/docs-gen/content/tools/3.1-cli/_index.md b/docs-gen/content/tools/3.1-cli/_index.md
diff --git a/docs-gen/content/tools/3.2-automation/_index.md b/docs-gen/content/tools/3.2-automation/_index.md
diff --git a/docs-gen/content/tools/_index.md b/docs-gen/content/tools/_index.md
diff --git a/docs-gen/layouts/index.html b/docs-gen/layouts/index.html
@@ -15,7 +15,7 @@ <h1>{{ .Title }}</h1>
       </div>
       <div class="col-lg-9 col-xl-8 text-center">
         <p class="lead">{{ .Params.lead | safeHTML }}</p>
-        <a class="btn btn-primary btn-cta rounded-1 btn-lg my-3" href="/docs" role="button">Get Started</a>
+        <a class="btn btn-primary btn-cta rounded-1 btn-lg my-3" href="/s2dm/docs" role="button">Get Started</a>
       </div>
     </div>
   </section>
@@ -86,17 +86,17 @@ <h3 class="h5">Interoperable</h3>
         <div class="col-lg-5 border rounded-1 bg-light bg-opacity-25">
           <h2 class="h4">S2DM Approach</h2>
           <p>Get a basic understanding of the S2DM approach for modeling data across multiple domains with minimal expertise required.</p>
-          <a href="/docs/approach-overview/" class="btn btn-outline-primary btn-sm mt-2">Learn More</a>
+          <a href="/s2dm/docs/approach-overview/" class="btn btn-outline-primary btn-sm mt-2">Learn More</a>
         </div>
         <div class="col-lg-5 border rounded-1 bg-light bg-opacity-25">
           <h2 class="h4">Data Modeling Guideline</h2>
           <p>Follow our comprehensive guideline to model your domain using S2DM principles and best practices.</p>
-          <a href="/docs/data-modeling-guideline/" class="btn btn-outline-primary btn-sm mt-2">View Guide</a>
+          <a href="/s2dm/docs/data-modeling-guideline/" class="btn btn-outline-primary btn-sm mt-2">View Guide</a>
         </div>
         <div class="col-lg-5 border rounded-1 bg-light bg-opacity-25">
           <h2 class="h4">S2DM Tools</h2>
           <p>Maintain your domain model with the support of our provided S2DM tools and automation utilities.</p>
-          <a href="/tools/" class="btn btn-outline-primary btn-sm mt-2">Explore Tools</a>
+          <a href="/s2dm/docs/tools/" class="btn btn-outline-primary btn-sm mt-2">Explore Tools</a>
         </div>
       </div>
     </div>
@@ -110,7 +110,7 @@ <h2 class="h4">S2DM Tools</h2>
         <div class="col-lg-7">
           <h2 class="mt-2 h5">Start modeling your data semantically today!</h2>
           <p class="text-muted">S2DM enables Subject Matter Experts to contribute to controlled vocabularies with minimal data modeling expertise.</p>
-          <a class="btn btn-outline-primary btn-lg rounded-1 px-4 my-2" href="/docs/approach-overview/" role="button">Get Started</a>
+          <a class="btn btn-outline-primary btn-lg rounded-1 px-4 my-2" href="/s2dm/docs/approach-overview/" role="button">Get Started</a>
         </div>
       </div>
     </section>
@@ -121,7 +121,7 @@ <h2 class="mt-2 h5">Start modeling your data semantically today!</h2>
     <div class="container">
       <div class="row justify-content-center text-center">
         <div class="col-auto">
-          <img src="/images/COVESA-Logo-Small.png" alt="COVESA Logo" class="img-fluid" style="max-height: 60px;">
+          <img src="/s2dm/images/COVESA-Logo-Small.png" alt="COVESA Logo" class="img-fluid" style="max-height: 60px;">
         </div>
       </div>
     </div>
diff --git a/docs-gen/layouts/partials/footer/esbuild.html b/docs-gen/layouts/partials/footer/esbuild.html
@@ -90,6 +90,6 @@
 {{- end -}}
 
 <script {{ with $load }}{{ . | safeHTMLAttr }}{{ end }}
-  src="{{- $js.Permalink -}}"
+  src="{{- $js.RelPermalink -}}"
   integrity="{{- $js.Data.Integrity -}}">
 </script>
diff --git a/docs-gen/resources/_gen/assets/scss/app.scss_bee030cf6e8c6b035b46933094959a46.content b/docs-gen/resources/_gen/assets/scss/app.scss_bee030cf6e8c6b035b46933094959a46.content
diff --git a/docs-gen/resources/_gen/assets/scss/app.scss_bee030cf6e8c6b035b46933094959a46.json b/docs-gen/resources/_gen/assets/scss/app.scss_bee030cf6e8c6b035b46933094959a46.json
@@ -1 +1 @@
-{"Target":"main.8f49141719321145914292f2c41aa505b98d6760eb47c5e524e8e144d7e8a24ed3234c85b7be69a7ce7f828f3566f5a156b8a69ed61f5c5672e4504356b49e96.css","MediaType":"text/css","Data":{"Integrity":"sha512-j0kUFxkyEUWRQpLyxBqlBbmNZ2DrR8XlJOjhRNfook7TI0yFt75pp85/go81ZvWhVrimntYfXFZy5FBDVrSelg=="}}
+{"Target":"main.a7a59fde2031e8f28e8bfc5ce308cb46869100ee47f5bf9c2727142b9d69280bc7a6b10ffc598ac53674d1f37d277d0ca68129a23187f87e4b789153ef16ed4a.css","MediaType":"text/css","Data":{"Integrity":"sha512-p6Wf3iAx6PKOi/xc4wjLRoaRAO5H9b+cJycUK51pKAvHprEP/FmKxTZ00fN9J30MpoEpojGH+H5LeJFT7xbtSg=="}}
diff --git a/docs-gen/resources/_gen/assets/scss/app.scss_cdf9d7c9eb97e4550ded64a8776dd9e8.content b/docs-gen/resources/_gen/assets/scss/app.scss_cdf9d7c9eb97e4550ded64a8776dd9e8.content
diff --git a/docs-gen/resources/_gen/assets/scss/app.scss_cdf9d7c9eb97e4550ded64a8776dd9e8.json b/docs-gen/resources/_gen/assets/scss/app.scss_cdf9d7c9eb97e4550ded64a8776dd9e8.json
@@ -0,0 +1 @@
+{"Target":"main.fe78597538379b6a3f99f0e3b391d6164ae15563463b578c62335cdc78bea24d47a834bb65d00a6ea9337c2550360e249b26f2fc73dd2eacad769a9d6d19bc98.css","MediaType":"text/css","Data":{"Integrity":"sha512-/nhZdTg3m2o/mfDjs5HWFkrhVWNGO1eMYjNc3Hi+ok1HqDS7ZdAKbqkzfCVQNg4kmyby/HPdLqytdpqdbRm8mA=="}}
