Skip to content

Commit 9cf654c

Browse files
Fix links in docs
1 parent 557dd83 commit 9cf654c

5 files changed

Lines changed: 14 additions & 14 deletions

File tree

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@
33

44
Turn Python-based image processing workflows into **algorithms** that gain extra functionalities.
55

6-
- [**Turn your algorithms into web servers**]() and run computations from [QuPath](https://github.com/Imaging-Server-Kit/qupath-extension-serverkit), [Napari](https://github.com/Imaging-Server-Kit/napari-serverkit), or [Python](08_python) via HTTP requests.
6+
- [**Turn your algorithms into web servers**](https://imaging-server-kit.github.io/imaging-server-kit/sections/07_server.html) and run computations from [QuPath](https://github.com/Imaging-Server-Kit/qupath-extension-serverkit), [Napari](https://github.com/Imaging-Server-Kit/napari-serverkit), or [Python](./sections/08_python) via HTTP requests.
77

88
https://github.com/user-attachments/assets/36bda69d-996e-4240-9a53-7e76d9ea3894
99

10-
- [**Generate dock widgets**]() to run your algorithms interactively in Napari.
10+
- [**Generate dock widgets**](https://imaging-server-kit.github.io/imaging-server-kit/sections/01_algorithm.html) to run your algorithms interactively in Napari.
1111

1212
https://github.com/user-attachments/assets/1ff572f7-f159-4f5a-afd4-7a157de3d9f8
1313

14-
- Run your algorithms [**tile-by-tile**]() on the input data.
14+
- Run your algorithms [**tile-by-tile**](https://imaging-server-kit.github.io/imaging-server-kit/sections/06_tiled.html) on the input data.
1515

1616
https://github.com/user-attachments/assets/47c2f734-5683-49d9-8aea-388c3a2bc16d
1717

18-
- [**Stream results**]() to inspect them in real-time.
18+
- [**Stream results**](https://imaging-server-kit.github.io/imaging-server-kit/sections/05_streams.html) to inspect them in real-time.
1919

2020
https://github.com/user-attachments/assets/a3f69a9f-fb68-4580-a804-6c57d5807b9a
2121

‎docs/index.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,33 +12,33 @@ Server Kit algorithms are versatile objects that allow you run computations in a
1212

1313
For example, you can
1414

15-
- [**Turn your algorithm into a web server**](07_server), connect to it and run computations from [QuPath](https://github.com/Imaging-Server-Kit/qupath-extension-serverkit), [Napari](https://github.com/Imaging-Server-Kit/napari-serverkit), or [Python](08_python) via HTTP requests.
15+
- [**Turn your algorithm into a web server**](./sections/07_server.md), connect to it and run computations from [QuPath](https://github.com/Imaging-Server-Kit/qupath-extension-serverkit), [Napari](https://github.com/Imaging-Server-Kit/napari-serverkit), or [Python](./sections/08_python) via HTTP requests.
1616

1717
<video width=512 controls loop autoplay>
1818
<source src="./_static/stardist_blobs.mp4" type="video/mp4">
1919
</video>
2020

21-
- [**Generate a dock widget**](01_algorithm) to run your algorithm interactively in Napari.
21+
- [**Generate a dock widget**](./sections/01_algorithm) to run your algorithm interactively in Napari.
2222

2323
<video width=512 controls loop autoplay>
2424
<source src="./_static/oripy_threshold.mp4" type="video/mp4">
2525
</video>
2626

27-
- Run your algorithm [**tile-by-tile**](06_tiled) on the input image.
27+
- Run your algorithm [**tile-by-tile**](./sections/06_tiled) on the input image.
2828

2929
<video width=512 controls loop autoplay>
3030
<source src="./_static/tiles.mp4" type="video/mp4">
3131
</video>
3232

33-
- [**Stream results**](05_streams) to inspect them in real-time.
33+
- [**Stream results**](./sections/05_streams) to inspect them in real-time.
3434

3535
<video width=512 controls loop autoplay>
3636
<source src="./_static/yolo-stream.mp4" type="video/webm">
3737
</video>
3838

39-
On top of that, you can [**validate data**](08_python) passed as algorithm parameters, provide [**samples**](02_samples), and generate [**documentation**](03_metadata) for your algorithm that you can share with users.
39+
On top of that, you can [**validate data**](./sections/08_python) passed as algorithm parameters, provide [**samples**](./sections/02_samples), and generate [**documentation**](./sections/03_metadata) for your algorithm that you can share with users.
4040

41-
This documentation will give you a conceptual overview of the package, and walk you through the steps to learn [how to create an algorithm](01_algorithm), and give you some [suggestions of use cases](11_examples).
41+
This documentation will give you a conceptual overview of the package, and walk you through the steps to learn [how to create an algorithm](./sections/01_algorithm), and give you some [suggestions of use cases](./sections/11_examples).
4242

4343
## Contents
4444

‎docs/sections/01_algorithm.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@
229229
"- `step` (for UI sliders)\n",
230230
"- `name` (label next to the parameter)\n",
231231
"\n",
232-
"There are many more data layers available. For a full list, see: [Data layers](10_types)\n",
232+
"There are many more data layers available. For a full list, see: [Data layers](./10_types)\n",
233233
"```\n",
234234
"\n",
235235
"While `parameters={}` is the most explicit and reliable annotation method, you can also use:\n",

‎docs/sections/08_python.ipynb‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -170,7 +170,7 @@
170170
"## Using `sk.Client`\n",
171171
"\n",
172172
"````{note}\n",
173-
"You need to run the \"server-side\" code from this section in a Python script (not a Jupyter notebook) as explained in [Serving algorithms](07_server) via:\n",
173+
"You need to run the \"server-side\" code from this section in a Python script (not a Jupyter notebook) as explained in [Serving algorithms](./07_server) via:\n",
174174
"\n",
175175
"```python\n",
176176
"...\n",

‎docs/sections/09_docker.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,5 +53,5 @@ Congratulations! You have seen all of the main features of *Imaging Server Kit*.
5353

5454
The last two sections of this documentation explore:
5555

56-
- [Data layers](10_types) - A reference of all available data layers.
57-
- [Examples](11_examples) - A gallery of example Server Kit algorithms for selected projects.
56+
- [Data layers](./10_types) - A reference of all available data layers.
57+
- [Examples](./11_examples) - A gallery of example Server Kit algorithms for selected projects.

0 commit comments

Comments
 (0)