From ad2d01101c6b766d89d6cd2d8919387feae85fda Mon Sep 17 00:00:00 2001 From: Wiktor Iwaszko Date: Thu, 11 Jun 2026 12:58:01 +0200 Subject: [PATCH 1/4] [DOCS] Adjustments for changes in docs build --- docs/user-guide/index.md_ | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/user-guide/index.md_ b/docs/user-guide/index.md_ index 14b8c98..6bbe2ef 100644 --- a/docs/user-guide/index.md_ +++ b/docs/user-guide/index.md_ @@ -7,8 +7,6 @@ pipeline. :::{toctree} :hidden: -Loss Prevention <./loss-prevention/index.md> -Order Accuracy <./order-accuracy/index.md> CV Pipeline Benchmarking <./benchmark.md> Troubleshooting <./troubleshooting.md> Release Notes <./release-notes.md> From 3c3191c305341d55d8e2ed05d69213194f093d94 Mon Sep 17 00:00:00 2001 From: Wiktor Iwaszko Date: Thu, 11 Jun 2026 13:48:13 +0200 Subject: [PATCH 2/4] move docs --- docs/user-guide/architecture/pipelines.md | 2 +- .../{ => documentation}/benchmark.md | 8 ++--- docs/user-guide/{ => documentation}/index.md_ | 0 .../user-guide/documentation/release-notes.md | 30 +++++++++++++++++++ .../{ => documentation}/troubleshooting.md | 0 docs/user-guide/release-notes.md | 30 ------------------- 6 files changed, 35 insertions(+), 35 deletions(-) rename docs/user-guide/{ => documentation}/benchmark.md (96%) rename docs/user-guide/{ => documentation}/index.md_ (100%) create mode 100644 docs/user-guide/documentation/release-notes.md rename docs/user-guide/{ => documentation}/troubleshooting.md (100%) delete mode 100644 docs/user-guide/release-notes.md diff --git a/docs/user-guide/architecture/pipelines.md b/docs/user-guide/architecture/pipelines.md index babbd18..b903bc1 100644 --- a/docs/user-guide/architecture/pipelines.md +++ b/docs/user-guide/architecture/pipelines.md @@ -50,4 +50,4 @@ When performance is more important than flexibility a developer can use the C AP ## Performance -More details about benchmarking pipelines can be found on the [Performance Tools Page](../benchmark.md). +More details about benchmarking pipelines can be found on the [Performance Tools Page](../documentation/benchmark.md). diff --git a/docs/user-guide/benchmark.md b/docs/user-guide/documentation/benchmark.md similarity index 96% rename from docs/user-guide/benchmark.md rename to docs/user-guide/documentation/benchmark.md index 20500bd..554a5aa 100644 --- a/docs/user-guide/benchmark.md +++ b/docs/user-guide/documentation/benchmark.md @@ -91,11 +91,11 @@ consumption, and so on. Specific number of pipelines with single container -![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-pipeline.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-pipeline.png) Specific number of pipelines with OVMS and Client -![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-pipeline-ovms.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-pipeline-ovms.png) ### Benchmark Stream Density for CV Pipelines @@ -116,10 +116,10 @@ where the parameters: > **Note:** It is recommended to set `--target_fps` to a value lesser than your target FPS to account for real world variances in hardware readings. Stream density with single container -![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-stream-density.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-stream-density.png) Stream density with OVMS and Client -![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-stream-density-ovms.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-stream-density-ovms.png) ### Consolidate results diff --git a/docs/user-guide/index.md_ b/docs/user-guide/documentation/index.md_ similarity index 100% rename from docs/user-guide/index.md_ rename to docs/user-guide/documentation/index.md_ diff --git a/docs/user-guide/documentation/release-notes.md b/docs/user-guide/documentation/release-notes.md new file mode 100644 index 0000000..6800ef7 --- /dev/null +++ b/docs/user-guide/documentation/release-notes.md @@ -0,0 +1,30 @@ +# Release Notes + +Release [v1.0.1](../release-notes/v1-0-1.md) + +Release [v1.5.0](../release-notes/v1-5-0.md) + +Release [v2.0.0](../release-notes/v2-0-0.md) + +Release [v2.1.0](../release-notes/v2-1-0.md) + +Release [v3.0.0](../release-notes/v3-0-0.md) + +Release [v3.1.0](../release-notes/v3-1-0.md) + +Release [v3.2.0](../release-notes/v3-2-0.md) + + diff --git a/docs/user-guide/troubleshooting.md b/docs/user-guide/documentation/troubleshooting.md similarity index 100% rename from docs/user-guide/troubleshooting.md rename to docs/user-guide/documentation/troubleshooting.md diff --git a/docs/user-guide/release-notes.md b/docs/user-guide/release-notes.md deleted file mode 100644 index 1903131..0000000 --- a/docs/user-guide/release-notes.md +++ /dev/null @@ -1,30 +0,0 @@ -# Release Notes - -Release [v1.0.1](./release-notes/v1-0-1.md) - -Release [v1.5.0](./release-notes/v1-5-0.md) - -Release [v2.0.0](./release-notes/v2-0-0.md) - -Release [v2.1.0](./release-notes/v2-1-0.md) - -Release [v3.0.0](./release-notes/v3-0-0.md) - -Release [v3.1.0](./release-notes/v3-1-0.md) - -Release [v3.2.0](./release-notes/v3-2-0.md) - - From 388a76deac2b86c87657c26f16d9b63a11d926fe Mon Sep 17 00:00:00 2001 From: Wiktor Iwaszko Date: Fri, 12 Jun 2026 05:48:41 +0200 Subject: [PATCH 3/4] move old release notes --- .../user-guide/documentation/release-notes.md | 26 +++++++++---------- .../release-notes/v1-0-1.md | 0 .../release-notes/v1-5-0.md | 0 .../release-notes/v2-0-0.md | 0 .../release-notes/v2-1-0.md | 0 .../release-notes/v3-0-0.md | 0 .../release-notes/v3-1-0.md | 0 .../release-notes/v3-2-0.md | 0 8 files changed, 13 insertions(+), 13 deletions(-) rename docs/user-guide/{ => documentation}/release-notes/v1-0-1.md (100%) rename docs/user-guide/{ => documentation}/release-notes/v1-5-0.md (100%) rename docs/user-guide/{ => documentation}/release-notes/v2-0-0.md (100%) rename docs/user-guide/{ => documentation}/release-notes/v2-1-0.md (100%) rename docs/user-guide/{ => documentation}/release-notes/v3-0-0.md (100%) rename docs/user-guide/{ => documentation}/release-notes/v3-1-0.md (100%) rename docs/user-guide/{ => documentation}/release-notes/v3-2-0.md (100%) diff --git a/docs/user-guide/documentation/release-notes.md b/docs/user-guide/documentation/release-notes.md index 6800ef7..ac41675 100644 --- a/docs/user-guide/documentation/release-notes.md +++ b/docs/user-guide/documentation/release-notes.md @@ -1,30 +1,30 @@ # Release Notes -Release [v1.0.1](../release-notes/v1-0-1.md) +Release [v3.2.0](./release-notes/v3-2-0.md) -Release [v1.5.0](../release-notes/v1-5-0.md) +Release [v3.1.0](./release-notes/v3-1-0.md) -Release [v2.0.0](../release-notes/v2-0-0.md) +Release [v3.0.0](./release-notes/v3-0-0.md) -Release [v2.1.0](../release-notes/v2-1-0.md) +Release [v2.1.0](./release-notes/v2-1-0.md) -Release [v3.0.0](../release-notes/v3-0-0.md) +Release [v2.0.0](./release-notes/v2-0-0.md) -Release [v3.1.0](../release-notes/v3-1-0.md) +Release [v1.5.0](./release-notes/v1-5-0.md) -Release [v3.2.0](../release-notes/v3-2-0.md) +Release [v1.0.1](./release-notes/v1-0-1.md) diff --git a/docs/user-guide/release-notes/v1-0-1.md b/docs/user-guide/documentation/release-notes/v1-0-1.md similarity index 100% rename from docs/user-guide/release-notes/v1-0-1.md rename to docs/user-guide/documentation/release-notes/v1-0-1.md diff --git a/docs/user-guide/release-notes/v1-5-0.md b/docs/user-guide/documentation/release-notes/v1-5-0.md similarity index 100% rename from docs/user-guide/release-notes/v1-5-0.md rename to docs/user-guide/documentation/release-notes/v1-5-0.md diff --git a/docs/user-guide/release-notes/v2-0-0.md b/docs/user-guide/documentation/release-notes/v2-0-0.md similarity index 100% rename from docs/user-guide/release-notes/v2-0-0.md rename to docs/user-guide/documentation/release-notes/v2-0-0.md diff --git a/docs/user-guide/release-notes/v2-1-0.md b/docs/user-guide/documentation/release-notes/v2-1-0.md similarity index 100% rename from docs/user-guide/release-notes/v2-1-0.md rename to docs/user-guide/documentation/release-notes/v2-1-0.md diff --git a/docs/user-guide/release-notes/v3-0-0.md b/docs/user-guide/documentation/release-notes/v3-0-0.md similarity index 100% rename from docs/user-guide/release-notes/v3-0-0.md rename to docs/user-guide/documentation/release-notes/v3-0-0.md diff --git a/docs/user-guide/release-notes/v3-1-0.md b/docs/user-guide/documentation/release-notes/v3-1-0.md similarity index 100% rename from docs/user-guide/release-notes/v3-1-0.md rename to docs/user-guide/documentation/release-notes/v3-1-0.md diff --git a/docs/user-guide/release-notes/v3-2-0.md b/docs/user-guide/documentation/release-notes/v3-2-0.md similarity index 100% rename from docs/user-guide/release-notes/v3-2-0.md rename to docs/user-guide/documentation/release-notes/v3-2-0.md From 12003ac5f97e7d90b4fd2648c8656f5d7cefa156 Mon Sep 17 00:00:00 2001 From: Wiktor Iwaszko Date: Fri, 12 Jun 2026 06:18:14 +0200 Subject: [PATCH 4/4] move images --- .../_assets/dlstreamer-pipeline.png | Bin .../_assets/intel-retail-repos.png | Bin .../{ => documentation}/_assets/logo-white-75px.png | Bin .../{ => documentation}/_assets/ovms-capi.png | Bin .../{ => documentation}/_assets/ovms-grpc.png | Bin .../_assets/performance-pipeline-ovms.png | Bin .../_assets/performance-pipeline.png | Bin .../_assets/performance-stream-density-ovms.png | Bin .../_assets/performance-stream-density.png | Bin docs/user-guide/documentation/benchmark.md | 8 ++++---- 10 files changed, 4 insertions(+), 4 deletions(-) rename docs/user-guide/{ => documentation}/_assets/dlstreamer-pipeline.png (100%) rename docs/user-guide/{ => documentation}/_assets/intel-retail-repos.png (100%) rename docs/user-guide/{ => documentation}/_assets/logo-white-75px.png (100%) rename docs/user-guide/{ => documentation}/_assets/ovms-capi.png (100%) rename docs/user-guide/{ => documentation}/_assets/ovms-grpc.png (100%) rename docs/user-guide/{ => documentation}/_assets/performance-pipeline-ovms.png (100%) rename docs/user-guide/{ => documentation}/_assets/performance-pipeline.png (100%) rename docs/user-guide/{ => documentation}/_assets/performance-stream-density-ovms.png (100%) rename docs/user-guide/{ => documentation}/_assets/performance-stream-density.png (100%) diff --git a/docs/user-guide/_assets/dlstreamer-pipeline.png b/docs/user-guide/documentation/_assets/dlstreamer-pipeline.png similarity index 100% rename from docs/user-guide/_assets/dlstreamer-pipeline.png rename to docs/user-guide/documentation/_assets/dlstreamer-pipeline.png diff --git a/docs/user-guide/_assets/intel-retail-repos.png b/docs/user-guide/documentation/_assets/intel-retail-repos.png similarity index 100% rename from docs/user-guide/_assets/intel-retail-repos.png rename to docs/user-guide/documentation/_assets/intel-retail-repos.png diff --git a/docs/user-guide/_assets/logo-white-75px.png b/docs/user-guide/documentation/_assets/logo-white-75px.png similarity index 100% rename from docs/user-guide/_assets/logo-white-75px.png rename to docs/user-guide/documentation/_assets/logo-white-75px.png diff --git a/docs/user-guide/_assets/ovms-capi.png b/docs/user-guide/documentation/_assets/ovms-capi.png similarity index 100% rename from docs/user-guide/_assets/ovms-capi.png rename to docs/user-guide/documentation/_assets/ovms-capi.png diff --git a/docs/user-guide/_assets/ovms-grpc.png b/docs/user-guide/documentation/_assets/ovms-grpc.png similarity index 100% rename from docs/user-guide/_assets/ovms-grpc.png rename to docs/user-guide/documentation/_assets/ovms-grpc.png diff --git a/docs/user-guide/_assets/performance-pipeline-ovms.png b/docs/user-guide/documentation/_assets/performance-pipeline-ovms.png similarity index 100% rename from docs/user-guide/_assets/performance-pipeline-ovms.png rename to docs/user-guide/documentation/_assets/performance-pipeline-ovms.png diff --git a/docs/user-guide/_assets/performance-pipeline.png b/docs/user-guide/documentation/_assets/performance-pipeline.png similarity index 100% rename from docs/user-guide/_assets/performance-pipeline.png rename to docs/user-guide/documentation/_assets/performance-pipeline.png diff --git a/docs/user-guide/_assets/performance-stream-density-ovms.png b/docs/user-guide/documentation/_assets/performance-stream-density-ovms.png similarity index 100% rename from docs/user-guide/_assets/performance-stream-density-ovms.png rename to docs/user-guide/documentation/_assets/performance-stream-density-ovms.png diff --git a/docs/user-guide/_assets/performance-stream-density.png b/docs/user-guide/documentation/_assets/performance-stream-density.png similarity index 100% rename from docs/user-guide/_assets/performance-stream-density.png rename to docs/user-guide/documentation/_assets/performance-stream-density.png diff --git a/docs/user-guide/documentation/benchmark.md b/docs/user-guide/documentation/benchmark.md index 554a5aa..20500bd 100644 --- a/docs/user-guide/documentation/benchmark.md +++ b/docs/user-guide/documentation/benchmark.md @@ -91,11 +91,11 @@ consumption, and so on. Specific number of pipelines with single container -![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-pipeline.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-pipeline.png) Specific number of pipelines with OVMS and Client -![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-pipeline-ovms.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-pipeline-ovms.png) ### Benchmark Stream Density for CV Pipelines @@ -116,10 +116,10 @@ where the parameters: > **Note:** It is recommended to set `--target_fps` to a value lesser than your target FPS to account for real world variances in hardware readings. Stream density with single container -![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-stream-density.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-stream-density.png) Stream density with OVMS and Client -![OpenVINO Model Server(OVMS) Pipeline with C-API](../_assets/performance-stream-density-ovms.png) +![OpenVINO Model Server(OVMS) Pipeline with C-API](./_assets/performance-stream-density-ovms.png) ### Consolidate results