docs: restructuring Interaction section in User Guide

This commit is contained in:
Mose Müller
2025-05-19 15:01:35 +02:00
parent b9cec19b02
commit 2c1db3fa45
7 changed files with 9 additions and 20 deletions

View File

@ -5,7 +5,7 @@
end="<!--getting-started-end-->" end="<!--getting-started-end-->"
%} %}
[RESTful API]: ./user-guide/interaction/README.md#restful-api [RESTful API]: ./user-guide/interaction/RESTful-API.md
[Python RPC Client]: ./user-guide/interaction/README.md#python-rpc-client [Python RPC Client]: ./user-guide/interaction/Python-Client.md
[Custom Components]: ./user-guide/Components.md#custom-components-pydasecomponents [Custom Components]: ./user-guide/Components.md#custom-components-pydasecomponents
[Components]: ./user-guide/Components.md [Components]: ./user-guide/Components.md

View File

@ -11,7 +11,7 @@
[Defining DataService]: ./getting-started.md#defining-a-dataservice [Defining DataService]: ./getting-started.md#defining-a-dataservice
[Web Interface Access]: ./getting-started.md#accessing-the-web-interface [Web Interface Access]: ./getting-started.md#accessing-the-web-interface
[Short RPC Client]: ./getting-started.md#connecting-to-the-service-via-python-rpc-client [Short RPC Client]: ./getting-started.md#connecting-to-the-service-via-python-rpc-client
[Customizing Web Interface]: ./user-guide/interaction/README.md#customization-options [Customizing Web Interface]: ./user-guide/interaction/Auto-generated-Frontend.md#customization-options
[Task Management]: ./user-guide/Tasks.md [Task Management]: ./user-guide/Tasks.md
[Units]: ./user-guide/Understanding-Units.md [Units]: ./user-guide/Understanding-Units.md
[Property Validation]: ./user-guide/Validating-Property-Setters.md [Property Validation]: ./user-guide/Validating-Property-Setters.md

View File

@ -46,8 +46,8 @@ example of how to separate service code from configuration.
port. Default: `8001`. port. Default: `8001`.
- **`GENERATE_WEB_SETTINGS`**: - **`GENERATE_WEB_SETTINGS`**:
When `true`, generates or updates the `web_settings.json` file (see [Tailoring Frontend Component Layout](../interaction/#tailoring-frontend-component-layout)). Existing entries are When `true`, generates or updates the `web_settings.json` file (see [Tailoring Frontend Component Layout](./interaction/Auto-generated-Frontend.md#tailoring-frontend-component-layout)).
preserved, and new entries are appended. Existing entries are preserved, and new entries are appended.
### Configuring `pydase` via Keyword Arguments ### Configuring `pydase` via Keyword Arguments

View File

@ -1,18 +1,7 @@
# Interacting with `pydase` Services # Interacting with `pydase` Services
`pydase` offers multiple ways for users to interact with the services they create, providing flexibility and convenience for different use cases. This section outlines the primary interaction methods available, including an auto-generated frontend, a RESTful API, and a Python client based on Socket.IO. `pydase` offers multiple ways for users to interact with the services they create.
{% - [Auto-generated Frontend](./Auto-generated-Frontend.md)
include-markdown "./Auto-generated Frontend.md" - [RESTful API](./RESTful-API.md)
heading-offset=1 - [Python Client](./Python-Client.md)
%}
{%
include-markdown "./RESTful API.md"
heading-offset=1
%}
{%
include-markdown "./Python Client.md"
heading-offset=1
%}