Skip to content

Commit 7704fee

Browse files
committed
add trailing slashes to links in docs
1 parent 13f3f2a commit 7704fee

File tree

10 files changed

+18
-18
lines changed

10 files changed

+18
-18
lines changed

docs/data/concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ The term "magnifications" is used synonymously for mags throughout the UI.
105105
At the moment, WEBKNOSSOS guarantees correct rendering of data with non-uniform mag factors only if the z-component between two mags changes by a factor of 1 or 2.
106106

107107
Most users do not create these metadata files manually.
108-
When using the [WEBKNOSSOS CLI](https://docs.webknossos.org/cli), a metadata file is automatically generated. Alternatively, you can create and edit WEBKNOSSOS datasets using the [WEBKNOSSOS Python library](https://github.com/scalableminds/webknossos-libs/).
108+
When using the [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/), a metadata file is automatically generated. Alternatively, you can create and edit WEBKNOSSOS datasets using the [WEBKNOSSOS Python library](https://github.com/scalableminds/webknossos-libs/).
109109
During the data import process, WEBKNOSSOS will ask for the necessary properties.
110110

111111
[See below for the full specification](#dataset-metadata-specification).

docs/data/export_python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Data Export through Python
22

3-
The [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/index.html) makes it very easy to download/upload any of your organization's datasets, and annotations. For detailed info, please refer to the `webknossos-libs` [documentation website for guides and tutorials](https://docs.webknossos.org/webknossos-py/index.html).
3+
The [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/) makes it very easy to download/upload any of your organization's datasets, and annotations. For detailed info, please refer to the `webknossos-libs` [documentation website for guides and tutorials](https://docs.webknossos.org/webknossos-py/).
44

55
There are also quick start instructions for Python download available directly from the [WEBKNOSSOS UI](./export_ui.md).

docs/data/image_stacks.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ WEBKNOSSOS understands most modern bio-imaging file formats and uses the [BioFor
5454

5555
You can manually convert image stacks through:
5656

57-
- [WEBKNOSSOS CLI](https://docs.webknossos.org/cli)
58-
- [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py)
57+
- [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/)
58+
- [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/)
5959

6060
### Conversion with CLI
6161
You can easily convert image stacks manually with the WEBKNOSSOS CLI.
@@ -75,11 +75,11 @@ This snippet converts an image stack that is located in directory called `data/s
7575
It will create a so called `color` layer containing your raw greyscale/color image.
7676
The supplied `--voxel-size` is specified in nanometers.
7777

78-
Read the full documentation at [WEBKNOSSOS CLI](https://docs.webknossos.org/cli).
78+
Read the full documentation at [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/).
7979

8080
### Conversion with Python
8181

82-
You can use the free [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py) to convert image stacks to Zarr v3 or integrate the conversion as part of an existing workflow.
82+
You can use the free [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/) to convert image stacks to Zarr v3 or integrate the conversion as part of an existing workflow.
8383

8484
```python
8585
import webknossos as wk

docs/data/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,6 @@ WEBKNOSSOS natively supports loading and streaming data in the following formats
1212

1313
The Zarr3 format is used for all internal voxel data representations - both for the raw (microscopy) image datasets and segmentations. Skeleton annotations are saved as NML files.
1414

15-
Any dataset uploaded to webknossos.org will automatically be converted to Zarr3 on upload - given its source file format is supported by WEBKNOSSOS. Alternatively, you can manually convert your datasets using the [WEBKNOSSOS CLI tool](https://docs.webknossos.org/cli) or use a custom script based on the [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/index.html).
15+
Any dataset uploaded to webknossos.org will automatically be converted to Zarr3 on upload - given its source file format is supported by WEBKNOSSOS. Alternatively, you can manually convert your datasets using the [WEBKNOSSOS CLI tool](https://docs.webknossos.org/cli/) or use a custom script based on the [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/).
1616

1717
Read more about uploading and configuring datasets on the [datasets page](../datasets/settings.md).

docs/data/upload_python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
### Uploading through Python
2-
For those wishing to automate dataset upload or to do it programmatically, check out the WEBKNOSSOS [Python library](https://docs.webknossos.org/webknossos-py). You can create, manage and upload datasets with the Python lib.
2+
For those wishing to automate dataset upload or to do it programmatically, check out the WEBKNOSSOS [Python library](https://docs.webknossos.org/webknossos-py/). You can create, manage and upload datasets with the Python lib.

docs/data/upload_ui.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Depending on the size of the dataset, the conversion will take some time.
2121
You can check the progress at the [`Jobs`](../automation/jobs.md) page or the "Datasets" tab in the dashboard.
2222
WEBKNOSSOS will also send you an email notification.
2323
- Convert your data manually to WKW. For this, we provide the following software tools and libraries:
24-
- The [WEBKNOSSOS CLI](https://docs.webknossos.org/cli) is a CLI tool that can convert many formats to WKW.
25-
- For other file formats, the [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/index.html) can be an option for custom scripting.
24+
- The [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/) is a CLI tool that can convert many formats to WKW.
25+
- For other file formats, the [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/) can be an option for custom scripting.
2626

2727
In particular, the following file formats are supported for uploading (and conversion):
2828

docs/data/zarr.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ For OME-Zarr (v0.5) datasets, the structure is slightly different (See [OME-Zarr
110110

111111
## Conversion to Zarr
112112

113-
You can easily convert image stacks manually with the [WEBKNOSSOS CLI](https://docs.webknossos.org/cli).
113+
You can easily convert image stacks manually with the [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/).
114114
The CLI tool expects a single file or all image files in a single folder with numbered file names.
115115
After installing, you can convert image stacks to Zarr datasets with the following command:
116116

@@ -132,11 +132,11 @@ This example will create a sharded Zarr v3 dataset with a voxel size of (11.24,
132132
A maximum of 4 parallel jobs will be used to parallelize the conversion, compression and downsampling.
133133
Using the `--data-format zarr` argument will produce unsharded Zarr v2 datasets.
134134

135-
Read the full documentation at [WEBKNOSSOS CLI](https://docs.webknossos.org/cli).
135+
Read the full documentation at [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/).
136136

137137
### Conversion with Python
138138

139-
You can use the free [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py) to convert image stacks to Zarr3 or integrate the conversion as part of an existing workflow.
139+
You can use the free [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/) to convert image stacks to Zarr3 or integrate the conversion as part of an existing workflow.
140140

141141
```python
142142
import webknossos as wk

docs/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ We have years of experience with automated machine learning analysis and [offer
2727
We are also always interested in new collaborations.
2828
Get in touch if you want to work together on a project resulting in new classifiers.
2929

30-
WEBKNOSSOS does not allow you to run custom machine learning models on your data yet. As a work-around you can download your annotations from WEBKNOSSOS - either manually or scripted [through our Python library](https://docs.webknossos.org/webknossos-py) - and do your ML analysis offline and use WEBKNOSSOS to inspect the results.
30+
WEBKNOSSOS does not allow you to run custom machine learning models on your data yet. As a work-around you can download your annotations from WEBKNOSSOS - either manually or scripted [through our Python library](https://docs.webknossos.org/webknossos-py/) - and do your ML analysis offline and use WEBKNOSSOS to inspect the results.
3131

3232
## How can I use my dataset with WEBKNOSSOS?
3333

3434
WEBKNOSSOS supports [WKW (optimized), OME-Zarr (NGFF), Neuroglancer Precomputed, N5, KNOSSOS cubes](./data/index.md), and image stacks (converted on upload). You can also connect to Neuroglancer Precomputed, N5, and Zarr datasets hosted in the cloud (Google Cloud Storage, AWS S3).
3535

36-
Smaller datasets (up to multiple GB) can be uploaded directly through the web interface. For larger datasets, we recommend converting them to the standard WKW format using the [WEBKNOSSOS CLI](https://docs.webknossos.org/cli) CLI tool and uploading it via the [WEBKNOSSOS Python package](https://docs.webknossos.org/webknossos-py/examples/upload_image_data.html).
36+
Smaller datasets (up to multiple GB) can be uploaded directly through the web interface. For larger datasets, we recommend converting them to the standard WKW format using the [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/) CLI tool and uploading it via the [WEBKNOSSOS Python package](https://docs.webknossos.org/webknossos-py/examples/upload_image_data.html).
3737

3838
## Can I host the WEBKNOSSOS data in my own compute cluster (on-premise installation)?
3939

@@ -53,7 +53,7 @@ For example, the WEBKNOSSOS main component could be hosted on commercial cloud i
5353
## Can I further analyze my annotations outside of WEBKNOSSOS with Python/MATLAB?
5454
Yes, you can. WEBKNOSSOS allows the download and export of skeleton annotations as NML files and segmentations/volume data as binary/wkw files.
5555

56-
Use our free [Python library](https://docs.webknossos.org/webknossos-py) to work with the WEBKNOSSOS standard formats.
56+
Use our free [Python library](https://docs.webknossos.org/webknossos-py/) to work with the WEBKNOSSOS standard formats.
5757

5858
## Newly registered users don't show up
5959

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ WEBKNOSSOS is also a platform for [showcasing datasets](https://webknossos.org)
2626
- Supports Time Series datasets
2727
- [3D Mesh Visualization](./meshes/index.md)
2828
- [Integrated Synapse and Connectome Viewer](./connectome_viewer.md)
29-
- [Python library with documentation for API access and integration in custom analysis workflows](https://docs.webknossos.org/webknossos-py/index.html)
29+
- [Python library with documentation for API access and integration in custom analysis workflows](https://docs.webknossos.org/webknossos-py/)
3030
- [Frontend API for user scripting](https://webknossos.org/assets/docs/frontend-api/index.html)
3131
- Developed as an open-source project with [automated testing](https://circleci.com/gh/scalableminds/webknossos)
3232
- [Deployable with Docker for production and development](https://hub.docker.com/r/scalableminds/webknossos/)

docs/skeleton_annotation/import_export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Importing a skeleton annotation can be achieved using one of two ways:
2323

2424
![Skeletons can be imported by drag and drop in the annotation view or from the dashboard](../images/tracing_ui_import.jpeg)
2525

26-
If you are looking to import/export annotations through Python code, check out our [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py).
26+
If you are looking to import/export annotations through Python code, check out our [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/).
2727

2828
## Merging skeleton annotations
2929

0 commit comments

Comments
 (0)