diff --git a/docs/getting-started.md b/docs/getting-started.md index e5b6bf0..2e62652 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -5,7 +5,7 @@ end="" %} -[RESTful API]: ./user-guide/interaction/README.md#restful-api -[Python RPC Client]: ./user-guide/interaction/README.md#python-rpc-client +[RESTful API]: ./user-guide/interaction/RESTful-API.md +[Python RPC Client]: ./user-guide/interaction/Python-Client.md [Custom Components]: ./user-guide/Components.md#custom-components-pydasecomponents [Components]: ./user-guide/Components.md diff --git a/docs/index.md b/docs/index.md index c198f93..949ae63 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,7 +11,7 @@ [Defining DataService]: ./getting-started.md#defining-a-dataservice [Web Interface Access]: ./getting-started.md#accessing-the-web-interface [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 [Units]: ./user-guide/Understanding-Units.md [Property Validation]: ./user-guide/Validating-Property-Setters.md diff --git a/docs/user-guide/Configuration.md b/docs/user-guide/Configuration.md index d65e0ae..19928b5 100644 --- a/docs/user-guide/Configuration.md +++ b/docs/user-guide/Configuration.md @@ -46,8 +46,8 @@ example of how to separate service code from configuration. port. Default: `8001`. - **`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 - preserved, and new entries are appended. + When `true`, generates or updates the `web_settings.json` file (see [Tailoring Frontend Component Layout](./interaction/Auto-generated-Frontend.md#tailoring-frontend-component-layout)). + Existing entries are preserved, and new entries are appended. ### Configuring `pydase` via Keyword Arguments diff --git a/docs/user-guide/interaction/Auto-generated Frontend.md b/docs/user-guide/interaction/Auto-generated-Frontend.md similarity index 100% rename from docs/user-guide/interaction/Auto-generated Frontend.md rename to docs/user-guide/interaction/Auto-generated-Frontend.md diff --git a/docs/user-guide/interaction/Python Client.md b/docs/user-guide/interaction/Python-Client.md similarity index 100% rename from docs/user-guide/interaction/Python Client.md rename to docs/user-guide/interaction/Python-Client.md diff --git a/docs/user-guide/interaction/README.md b/docs/user-guide/interaction/README.md index e363cde..22b6b5a 100644 --- a/docs/user-guide/interaction/README.md +++ b/docs/user-guide/interaction/README.md @@ -1,18 +1,7 @@ # 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. -{% - include-markdown "./Auto-generated Frontend.md" - heading-offset=1 -%} - -{% - include-markdown "./RESTful API.md" - heading-offset=1 -%} - -{% - include-markdown "./Python Client.md" - heading-offset=1 -%} +- [Auto-generated Frontend](./Auto-generated-Frontend.md) +- [RESTful API](./RESTful-API.md) +- [Python Client](./Python-Client.md) diff --git a/docs/user-guide/interaction/RESTful API.md b/docs/user-guide/interaction/RESTful-API.md similarity index 100% rename from docs/user-guide/interaction/RESTful API.md rename to docs/user-guide/interaction/RESTful-API.md