add trailing slashes to links in docs #8923
Conversation
📝 WalkthroughWalkthroughStandardized documentation hyperlinks to WEBKNOSSOS resources by adding trailing slashes and replacing index.html with directory paths across multiple markdown files. No content, structure, or code behavior changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
Tip 👮 Agentic pre-merge checks are now available in preview!Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.
Please see the documentation for more information. Example: reviews:
pre_merge_checks:
custom_checks:
- name: "Undocumented Breaking Changes"
mode: "warning"
instructions: |
Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).Please share your feedback with us on this Discord post. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/data/upload_ui.md (1)
24-25: Fix markdown list indentation to satisfy markdownlint (MD007)Dedent nested list items by two spaces under the bullet at Line 23.
- - The [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/) is a CLI tool that can convert many formats to WKW. - - For other file formats, the [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/) can be an option for custom scripting. + - The [WEBKNOSSOS CLI](https://docs.webknossos.org/cli/) is a CLI tool that can convert many formats to WKW. + - For other file formats, the [WEBKNOSSOS Python library](https://docs.webknossos.org/webknossos-py/) can be an option for custom scripting.docs/faq.md (1)
36-36: Nit: “CLI” duplicated in phrasing.Reads “using the … CLI CLI tool”. Drop one “CLI”.
-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). +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/) and uploading it via the [WEBKNOSSOS Python package](https://docs.webknossos.org/webknossos-py/examples/upload_image_data.html).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (10)
docs/data/concepts.md(1 hunks)docs/data/export_python.md(1 hunks)docs/data/image_stacks.md(2 hunks)docs/data/index.md(1 hunks)docs/data/upload_python.md(1 hunks)docs/data/upload_ui.md(1 hunks)docs/data/zarr.md(2 hunks)docs/faq.md(2 hunks)docs/index.md(1 hunks)docs/skeleton_annotation/import_export.md(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2024-11-25T14:52:23.201Z
Learnt from: MichaelBuessemeyer
PR: scalableminds/webknossos#8221
File: CHANGELOG.unreleased.md:14-14
Timestamp: 2024-11-25T14:52:23.201Z
Learning: For the `webknossos` project, changelog entries in `CHANGELOG.unreleased.md` should be concise and avoid unnecessary detailed explanations.
Applied to files:
docs/data/concepts.md
📚 Learning: 2025-05-12T14:15:05.259Z
Learnt from: frcroth
PR: scalableminds/webknossos#8609
File: conf/evolutions/133-datasource-properties-in-db.sql:8-16
Timestamp: 2025-05-12T14:15:05.259Z
Learning: The database schema in WEBKNOSSOS has separate tables for dataset layers (`dataset_layers`) and magnifications (`dataset_mags`). The `dataFormat` field is stored in the layers table while magnification-specific fields like `cubeLength` (specific to WKW format) are stored in the mags table.
Applied to files:
docs/data/concepts.md
🪛 markdownlint-cli2 (0.17.2)
docs/data/upload_ui.md
24-24: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
25-25: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: build-smoketest-push
- GitHub Check: frontend-tests
- GitHub Check: backend-tests
🔇 Additional comments (15)
docs/data/upload_python.md (1)
2-2: LGTM — link normalized with trailing slashConsistent with the PR goal; no further issues spotted here.
docs/skeleton_annotation/import_export.md (1)
26-26: LGTM — Python library link updatedMatches the trailing‑slash convention applied elsewhere.
docs/data/export_python.md (1)
3-3: LGTM — both occurrences use trailing‑slash docs URLGood consistency in a single sentence; no action needed.
docs/index.md (1)
29-29: LGTM — updated to directory URLCanonical trailing‑slash for the Python docs looks correct.
docs/data/concepts.md (1)
108-108: LGTM — CLI link normalizedTrailing slash added; surrounding GitHub link intentionally unchanged.
docs/data/index.md (1)
15-15: LGTM — normalized CLI and Python docs linksBoth links now point to directory roots; consistent with the rest of the docs.
docs/data/zarr.md (3)
113-113: LGTM — CLI link uses trailing slash
135-135: LGTM — “Read the full documentation” link normalized
139-139: LGTM — Python library link normalizeddocs/data/image_stacks.md (4)
57-58: Trailing slashes look correct.Both docs URLs resolve with trailing slashes; good consistency with the PR goal.
78-78: LGTM on CLI docs link.Consistent trailing slash; matches other references.
82-82: LGTM on Python library link.Corrected to /webknossos-py/ with trailing slash; consistent across docs.
57-58: Optional: quick link check — re-run with robust URL extractionRan the suggested check on docs/data/image_stacks.md and docs/faq.md: all real URLs returned HTTP 200, but curl errored on a malformed extraction that included trailing markdown characters (e.g.
https://forum.image.sc/tag/webknossos](https://forum.image.sc/tag/webknossos). Re-run using a regex that excludes trailing)/]or use a markdown-aware parser. Suggested re-check script:#!/bin/bash set -euo pipefail files=(docs/data/image_stacks.md docs/faq.md) urls=$(grep -hoE 'https?://[^)\]\s]+' "${files[@]}" | sort -u) for u in $urls; do code=$(curl -sSIL -o /dev/null -w '%{http_code}' "$u" || echo "000") echo "$code $u" donedocs/faq.md (2)
30-30: LGTM on Python library link.Updated to /webknossos-py/ with trailing slash; consistent with other pages.
56-56: LGTM on Python library link.Trailing slash added; consistent with the rest of the PR.
Adds trailing slashes to links in docs