Skip to content

Commit

Permalink
fix docs links (#35)
Browse files Browse the repository at this point in the history
* Update README.md

* Update docs README.md
  • Loading branch information
KohlerL-Smns authored Feb 26, 2024
1 parent f19434a commit 4c11584
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,11 @@
Using the IIH Essentials Development Kit​ you can develop apps based on the IIH Essentials and integrate them into Siemens Industrial Edge.

In this repository you can find the following components:
- <a href="docker-compose.example.yml">​Docker file: docker-compose.example.yml</a>
- <a href="./docs">Documentation</a>
- <a href="./docs/iih-essentials">IIH Essentials documentation and ​API specification</a>
- <a href="./docs/development-kit">Development Kit documentation</a>
- <a href="./examples">Examples</a>
- [​Docker file: docker-compose.example.yml](docker-compose.example.yml)
- [Documentation](https://industrial-edge.github.io/iih-essentials-development-kit/iih-essentials/)
- [Examples](./examples)

By running the docker compose configuration, an API instance of the IIH Essentials will be started on your machine. This can be used to easily develop and test your application during development. The API specification is available [here: API specification](./docs/iih-essentials/api-documentation/data-service-api-specification.html). This file needs to be opened locally in a browser.
By running the docker compose configuration, an API instance of the IIH Essentials will be started on your machine. This can be used to easily develop and test your application during development. The API specification is available [here: API specification](https://industrial-edge.github.io/iih-essentials-development-kit/iih-essentials/api/openapi/). This file needs to be opened locally in a browser.

An image is loaded from Docker Hub, containing these components:

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
## IIH Essentials Documentation
[Click here](./iih-essentials) to open the IIH Essentials documentation.
[Click here](https://industrial-edge.github.io/iih-essentials-development-kit/iih-essentials/) to open the IIH Essentials documentation.

0 comments on commit 4c11584

Please sign in to comment.