diff --git a/README.md b/README.md index 033acf9..d272df4 100644 --- a/README.md +++ b/README.md @@ -159,6 +159,9 @@ In this example, replace `` with the IP address of the machine where th ## Understanding the Component System + + + In `pydase`, components are fundamental building blocks that bridge the Python backend logic with frontend visual representation and interactions. This system can be understood based on the following categories: ### Built-in Type and Enum Components @@ -284,6 +287,8 @@ Below are the components available in the `pydase.components` module, accompanie Users can also extend the library by creating custom components. This involves defining the behavior on the Python backend and the visual representation on the frontend. For those looking to introduce new components, the [guide on adding components](https://pydase.readthedocs.io/en/latest/dev-guide/Adding_Components/) provides detailed steps on achieving this. + + ## Understanding Service Persistence `pydase` allows you to easily persist the state of your service by saving it to a file. This is especially useful when you want to maintain the service's state across different runs. diff --git a/docs/user-guide/Components.md b/docs/user-guide/Components.md new file mode 100644 index 0000000..3ad4ed4 --- /dev/null +++ b/docs/user-guide/Components.md @@ -0,0 +1,7 @@ +# Components Guide +{% + include-markdown "../../README.md" + start="" + end="" + heading-offset=-2 +%} diff --git a/mkdocs.yml b/mkdocs.yml index e1ec0cd..deb4c3a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,6 +4,8 @@ edit_uri: blob/docs/docs/ nav: - Home: index.md - Getting Started: getting-started.md + - User Guide: + - Components Guide: user-guide/Components.md - Developer Guide: - Developer Guide: dev-guide/README.md - API Reference: dev-guide/api.md @@ -22,7 +24,6 @@ markdown_extensions: - smarty - toc: permalink: true - baselevel: 4 - pymdownx.highlight: anchor_linenums: true - pymdownx.snippets @@ -38,5 +39,3 @@ plugins: watch: - src/pydase - - \ No newline at end of file