Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor Issue 51: move documentation from individual services to a new section under Automated Self Checkout in doc repo #3

Merged
merged 6 commits into from
Mar 5, 2025
Merged

Refactor Issue 51: move documentation from individual services to a new section under Automated Self Checkout in doc repo #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a07b605
docs: update performance tools documentation
antoniomtz Mar 3, 2025
c1bb360
Merge pull request #53 from antoniomtz/improve-performance-tools-docs
antoniomtz Mar 3, 2025
ec358bb
updating website
antoniomtz Mar 3, 2025
60ae0a1
Merge pull request #55 from antoniomtz/update-docs
antoniomtz Mar 3, 2025
3cee708
refactor: add md to use-cases/automated-self-checkout
ysvoon Mar 5, 2025
2134d04
refactor: modify mkdocs.yaml
ysvoon Mar 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ docs-builder-image:
build-docs: docs-builder-image
docker run --rm \
-u $(shell id -u):$(shell id -g) \
--env http_proxy=${HTTP_PROXY} \
--env https_proxy=${HTTPS_PROXY} \
-v $(PWD):/docs \
-w /docs \
$(MKDOCS_IMAGE) \
Expand All @@ -30,7 +32,7 @@ serve-docs: docs-builder-image
docker run --rm \
-it \
-u $(shell id -u):$(shell id -g) \
-p 8008:8000 \
-p 8000:8000 \
-v $(PWD):/docs \
-w /docs \
$(MKDOCS_IMAGE)
6 changes: 3 additions & 3 deletions docs/404.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@


<link rel="icon" href="/documentation/assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>Intel® Retail Organization</title>



<link rel="stylesheet" href="/documentation/assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="/documentation/assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1325,7 +1325,7 @@ <h1>404 - Not found</h1>
<script id="__config" type="application/json">{"base": "/documentation/", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "/documentation/assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="/documentation/assets/javascripts/bundle.5090c770.min.js"></script>
<script src="/documentation/assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/Architecture/pipelines.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>Pipelines - Intel® Retail Organization</title>



<link rel="stylesheet" href="../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1548,7 +1548,7 @@ <h2 id="performance">Performance</h2>
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="../assets/javascripts/bundle.5090c770.min.js"></script>
<script src="../assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/Architecture/v2.0.0/distributed-architecture.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>Distributed Architecture - Intel® Retail Organization</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1572,7 +1572,7 @@ <h2 id="references">References</h2>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="../../assets/javascripts/bundle.5090c770.min.js"></script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/Architecture/v2.0.0/multiple-ovms-json-config.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>Multiple OVMS JSON Config - Intel® Retail Organization</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1584,7 +1584,7 @@ <h2 id="references">References</h2>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="../../assets/javascripts/bundle.5090c770.min.js"></script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/Architecture/v2.0.0/performance_benchmarking.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>Performance Benchmarking - Intel® Retail Organization</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1618,7 +1618,7 @@ <h2 id="references">References</h2>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="../../assets/javascripts/bundle.5090c770.min.js"></script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/Architecture/v2.0.0/profile-launcher.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>Profile Launcher - Intel® Retail Organization</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1569,7 +1569,7 @@ <h2 id="references">References</h2>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="../../assets/javascripts/bundle.5090c770.min.js"></script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/Architecture/v2.0.0/target-device.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>Target Device - Intel® Retail Organization</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1616,7 +1616,7 @@ <h2 id="references">References</h2>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="../../assets/javascripts/bundle.5090c770.min.js"></script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
6 changes: 3 additions & 3 deletions docs/Architecture/v3.0.0/aicsd-integration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@


<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.1">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.7">



<title>AiCSD Integration - Intel® Retail Organization</title>



<link rel="stylesheet" href="../../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/main.8608ea7d.min.css">



Expand Down Expand Up @@ -1585,7 +1585,7 @@ <h2 id="references">References</h2>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "content.code.select", "content.code.annotate", "navigation.tabs", "navigation.tabs.sticky", "navigation.footer", "navigation.tracking", "search.suggest", "search.highlight", "navigation.top", "toc.follow", "toc.integrate"], "search": "../../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>


<script src="../../assets/javascripts/bundle.5090c770.min.js"></script>
<script src="../../assets/javascripts/bundle.c8b220af.min.js"></script>

<script src="https://unpkg.com/lunr/lunr.js"></script>

Expand Down
16 changes: 0 additions & 16 deletions docs/assets/javascripts/bundle.5090c770.min.js
View file
Open in desktop

This file was deleted.

Loading