docs: update for rtd

helmut-hoffer-von-ankershoffen · helmut-hoffer-von-ankershoffen · commit a29e7332043a · 2025-05-23T14:43:11.000+02:00
diff --git a/CLI_REFERENCE.md b/CLI_REFERENCE.md
@@ -14,7 +14,7 @@ $ aignostics [OPTIONS] COMMAND [ARGS]...
 * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
 * `--help`: Show this message and exit.
 
-🔬 Aignostics Python SDK v0.2.1 - built with love in Berlin 🐻
+🔬 Aignostics Python SDK v0.2.2 - built with love in Berlin 🐻
 
 **Commands**:
 
@@ -203,7 +203,7 @@ $ aignostics application run upload [OPTIONS] APPLICATION_VERSION_ID METADATA_CS
 
 **Options**:
 
-* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds.  [default: 1748000673214.913]
+* `--upload-prefix TEXT`: Prefix for the upload destination. If not given will be set to current milliseconds.  [default: 1748004154447.326]
 * `--help`: Show this message and exit.
 
 #### `aignostics application run submit`
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@
 ---
 
 
-## 1) Introduction
+## Introduction
 
 The **Aignostics Python SDK** includes multiple pathways to interact with the
 **Aignostics Platform**:
@@ -57,11 +57,13 @@ more about how we achieve
 [operational excellence](https://aignostics.readthedocs.io/en/latest/operational_excellence.html) and
 [security](https://aignostics.readthedocs.io/en/latest/security.html).
 
-## 2) Quick Start
+## Quick Start
 
 > [!Note]
 > See as follows for a quick start guide to get you up and running with the Aignostics Python SDK as quickly as possible. 
-> If you first want to learn bout the basic concepts and components of the Aignostics Platform, please jump to section 3 below.
+> If you first want to learn bout the basic concepts and components of the Aignostics Platform skip to that section below. 
+> The further reading section points you to reference documentation listing all available CLI commans, methods and classes provided by the SDK, how we achieve operational excellence and security, and more. 
+> If you are not familiar with terminology please check the glossary at the end of this document.
 
 ### Aignostics Launchpad: Run your first computational pathology analysis in 10 minutes from your desktop
 
@@ -272,7 +274,7 @@ Self-signed URLs for files in google storage buckets can be generated using the
 for the Google Storage Bucket**
 
 
-## 3) Aignostics Platform: Concepts
+## Aignostics Platform
 
 ### Overview
 
@@ -378,7 +380,7 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
 **[Read the API reference documentation](https://aignostics.readthedocs.io/en/latest/api_reference_v1.html)** or use our **[Interactive API Explorer](https://platform.aignostics.com/explore-api)** to dive into details of all operations and parameters.
 
 
-## 4) Further Reading
+## Further Reading
 
 1. Inspect our
    [security policy](https://aignostics.readthedocs.io/en/latest/security.html)
@@ -403,7 +405,7 @@ Every WSI processed by the Platform generates a cost. Usage of the "Test Applica
    that this project builds upon. Thank you to all these wonderful contributors!
 
 
-## 5) Glossary
+## Glossary
 
 ### A
 
diff --git a/docs/partials/README_footer.md b/docs/partials/README_footer.md
@@ -1,4 +1,4 @@
-## 4) Further Reading
+## Further Reading
 
 1. Inspect our
    [security policy](https://aignostics.readthedocs.io/en/latest/security.html)
diff --git a/docs/partials/README_glossary.md b/docs/partials/README_glossary.md
@@ -1,4 +1,4 @@
-## 5) Glossary
+## Glossary
 
 ### A
 
diff --git a/docs/partials/README_main.md b/docs/partials/README_main.md
@@ -1,4 +1,4 @@
-## 1) Introduction
+## Introduction
 
 The **Aignostics Python SDK** includes multiple pathways to interact with the
 **Aignostics Platform**:
@@ -35,11 +35,13 @@ more about how we achieve
 [operational excellence](https://aignostics.readthedocs.io/en/latest/operational_excellence.html) and
 [security](https://aignostics.readthedocs.io/en/latest/security.html).
 
-## 2) Quick Start
+## Quick Start
 
 > [!Note]
 > See as follows for a quick start guide to get you up and running with the Aignostics Python SDK as quickly as possible. 
-> If you first want to learn bout the basic concepts and components of the Aignostics Platform, please jump to section 3 below.
+> If you first want to learn bout the basic concepts and components of the Aignostics Platform skip to that section below. 
+> The further reading section points you to reference documentation listing all available CLI commans, methods and classes provided by the SDK, how we achieve operational excellence and security, and more. 
+> If you are not familiar with terminology please check the glossary at the end of this document.
 
 ### Aignostics Launchpad: Run your first computational pathology analysis in 10 minutes from your desktop
 
diff --git a/docs/partials/README_platform.md b/docs/partials/README_platform.md
@@ -1,4 +1,4 @@
-## 3) Aignostics Platform: Concepts
+## Aignostics Platform
 
 ### Overview
 
diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../partials/README_glossary.md
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -17,6 +17,7 @@
    api_reference_v1
    operational_excellence
    security
+   glossary
    license
    attributions
    release-notes
diff --git a/docs/source/main.rst b/docs/source/main.rst
@@ -1,2 +1,2 @@
 .. mdinclude:: ../partials/README_main.md
-.. mdinclude:: ../partials/README_api.md
+.. mdinclude:: ../partials/README_platform.md

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## 4) Further Reading`
	`1`	`+## Further Reading`
`2`	`2`
`3`	`3`	`1. Inspect our`
`4`	`4`	`[security policy](https://aignostics.readthedocs.io/en/latest/security.html)`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## 5) Glossary`
	`1`	`+## Glossary`
`2`	`2`
`3`	`3`	`### A`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-## 3) Aignostics Platform: Concepts`
	`1`	`+## Aignostics Platform`
`2`	`2`
`3`	`3`	`### Overview`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+.. mdinclude:: ../partials/README_glossary.md`
Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`.. mdinclude:: ../partials/README_main.md`
`2`		`-.. mdinclude:: ../partials/README_api.md`
	`2`	`+.. mdinclude:: ../partials/README_platform.md`