Merge pull request #5 from ZeissIQS/2022-new-headings-intros

Modified metadata, headings and intros
ZeissIQS · Oct 12, 2023 · 747ce9f · 747ce9f
2 parents 2a0b371 + 1cb01b8
commit 747ce9f
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 11 deletions.
diff --git a/doc/howtos/python_api_introduction/python_api_introduction.md b/doc/howtos/python_api_introduction/python_api_introduction.md
@@ -4,9 +4,9 @@ myst:
       "description": "Introduction to the Python API for extending GOM Inspect 2022 with Packages/Add-ons"
       "keywords": "Metrology, GOM Inspect, Python API, GOM API, Scripting, Packages, Add-ons, How-tos"
 ---
-# Python API introduction
+# GOM Inspect Python API introduction
 
-## Introduction to Python scripting
+Welcome to the GOM Inspect Python API introduction. This is your starting point into Add-on development for GOM Inspect. Here you find out what you can do with Add-ons, how they work and how you create them.
 
 See [Introduction to Python Scripting](https://techguide.gom.com/en/gom-software-2022/article/introduction_to_python_scripting.html) if you are new to Python or the GOM Software Python interface. 
 

diff --git a/doc/index.md b/doc/index.md
@@ -4,9 +4,9 @@ myst:
       "description": "Introduction to the Python API for extending GOM Inspect 2022 with Packages/Add-ons"
       "keywords": "Metrology, GOM Inspect, Python API, GOM API, Scripting, Packages, Add-ons, How-tos"
 ---
-# Add-On Documentation
+# GOM Inspect Add-On Development Documentation
 
-Welcome to the Add-On documentation. With Add-Ons, you will be able to customize and extend the functionality of your GOM Inspect software. 
+Welcome to the GOM Inspect Add-On development documentation. With Add-Ons, you will be able to customize and extend the functionality of your GOM Inspect software. 
 You can include several template configurations from the software, as well as completely new workflows programmed in python.
 
 ```{note}

diff --git a/doc/python_api/python_api.md b/doc/python_api/python_api.md
@@ -4,13 +4,9 @@ myst:
       "description": "GOM Inspect 2022 Add-on Python API Specification"
       "keywords": "Metrology, GOM Inspect, Python API, GOM API, Scripting, Packages, Add-ons, Specification, Documentation"
 ---
-# Python API functions
+# GOM Inspect Python API documentation
 
-## Basics
-
-```{note}
-This document describes the emerging GOM Python API.
-```
+Welcome to the GOM Inspect Python API documentation. Here you can find a detailed documentation of a subset of the Add-on programming specification. Please bear in mind, that recording commands with the script editor can be used to add new functions to your script.
 
 ```{important}
 The now preliminary API is currently under heavy development and will change massively in the near future.

diff --git a/doc/python_examples/index.md b/doc/python_examples/index.md
@@ -6,7 +6,7 @@ myst:
 ---
 # Overview
 
-Welcome to the Python API Examples. Here you can find the documentation of the examples which are provided by the
+Welcome to the GOM Inspect Python API Examples. Here you can find the documentation of the examples which are provided by the
 `Python API Examples` Add-On. You can reuse and adapt these code examples to your specific use case and learn the best-practices we recommend.
 
 ## How the examples are structured