Add image captions to documentation #8947
Conversation
📝 WalkthroughWalkthroughThis PR applies widespread documentation-only edits: primarily inserting image caption blocks (/// caption ... ///), normalizing whitespace/newlines, minor wording/alt-text tweaks, and a dataset metadata clarification splitting Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (4)
🚧 Files skipped from review as they are similar to previous changes (4)
⏰ 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)
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: 1
🧹 Nitpick comments (48)
docs/faq.md (1)
63-63: Clarify UI label and wording; ensure it matches the product exactly.If the actual UI control label differs (capitalization/quotes, “filter” vs “option”), mirror it verbatim. “Disable” is also more common than “Deactivate” for a toggle.
Optional copy tweak if it matches the UI:
-Deactivate the `Show Active Users Only` option above the User table. +Disable the "Show active users only" filter above the Users table.Also: this change seems unrelated to “image captions” (PR scope). Confirm it’s intentional.
docs/proofreading/index.md (1)
9-9: Minor copy/style tweak for consistency and readability.Suggest capitalizing tool names and adding a comma for flow; also verify the target page title matches the link text.
-3. Voxel-based relabeling of segments. Segments can be merged using the fill tool. To split segments there is a dedicated [Split Segments toolkit](split_segments_toolkit.md). +3. Voxel-based relabeling of segments. Segments can be merged using the Fill tool. To split segments, use the dedicated [Split Segments Toolkit](split_segments_toolkit.md).If “fill tool” is intentionally lowercase in the style guide, keep it as-is and only add the comma.
docs/users/access_rights.md (1)
47-47: Clarify UI label and align terminology.Use the exact menu label and consistent role naming. Suggest replacing “wK Statistics Menu” with the precise UI string and backticks; also consider using “Member” to match earlier text.
Proposed edit:
-| Access to wK Statistics Menu | Yes | No | Yes | No | +| Access to `Statistics` menu | Yes | No | Yes | No |Optional follow-up (outside this line): harmonize “Team Member” → “Member” throughout the table for consistency with the role list above.
docs/users/organizations.md (3)
46-46: Fix grammar and clarity in example sentence.Correct typos and phrasing for readability.
Apply this diff:
-A WEBKNOSSOS user account can be part of more than one organization, .e.g., when your are invited to collaborate on projects of another institute, working as a different WEBKNOSSOS organization. +A WEBKNOSSOS user account can be part of more than one organization, e.g., when you are invited to collaborate on projects at another institute or with a different WEBKNOSSOS organization.
50-50: Punctuation: add comma after “i.e.” and tighten sentence.Minor readability/punctuation fix.
Apply this diff:
-WEBKNOSSOS will quickly reload and switch your account to that organization, i.e. refresh your dashboard, access permissions, annotations, etc. to match your account in the selected organization. +WEBKNOSSOS will quickly reload and switch your account to that organization, i.e., refresh your dashboard, access permissions, and annotations to match your account in the selected organization.
10-10: Hyphenate “fine‑tune.”Minor copy edit.
Apply this diff:
-You can finetune access rights to datasets and visibility on the dashboard on various levels. +You can fine-tune access rights to datasets and visibility on the dashboard on various levels.docs/data/streaming.md (1)
30-30: Add caption/title + better alt text; consider youtube-nocookie for privacy.To align with the new “image captions” effort and improve accessibility, give the embed a descriptive alt and a title (used as caption in many MkDocs setups). Also, prefer youtube-nocookie to reduce tracking.
- +If captions in this repo are driven by a specific feature flag (e.g., theme.features) or attribute syntax (e.g., { figcaption }), confirm whether titles or attribute lists are required for visible captions and adjust accordingly.
docs/today_i_learned.md (1)
9-10: Optional: improve accessibility and consistency (no behavior change intended)
- Consider disabling autoplay/loop for motion/accessibility.
- Optionally add a figcaption for consistency with the new caption patterns elsewhere.
Apply this diff if you agree:
- <iframe width="560" height="560" src="https://www.youtube-nocookie.com/embed/videoseries?si=CqXiVKkxxFU8uETH&list=PLpizOgyiA4kEGKFRQFOgjucZCKtI2GUZY&autoplay=1&loop=1&mute=1" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> + <iframe width="560" height="560" src="https://www.youtube-nocookie.com/embed/videoseries?si=CqXiVKkxxFU8uETH&list=PLpizOgyiA4kEGKFRQFOgjucZCKtI2GUZY" title="webKnossos Tips & Tricks playlist" frameborder="0" allow="accelerometer; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> + <figcaption>webKnossos Tips & Tricks playlist</figcaption>docs/proofreading/proofreading_tool.md (4)
34-35: Admonition syntax: add space after!!!so it renders.MkDocs Material expects
!!! info(with a space). Current!!!infomay render as plain text.-!!!info +!!! info The proofreading tool requires a super-voxel graph representation of a segmentation to work. At this time, these can only be obtained from the [Voxelytics AI segmentation pipeline](https://voxelytics.com). We are actively working to make this available for more users, so please reach out to us to get you started and provide feedback: [[email protected]](mailto:[email protected])
6-6: Optional: add a title to trigger an image caption (aligns with PR goal).If captions are enabled via image titles, adding one here will show a caption below the embedded video.
- +
8-9: Microcopy: comma placement for readability.Removes the unnecessary comma after “Once” and adds one after the clause.
-To use the proofreading tool you need to enable an [ID mapping for your segmentation](./segmentation_mappings.md) to load the super-voxel graph. Once, WEBKNOSSOS detects this the proofreading tool can be activated on the toolbar (clipboard icon): +To use the proofreading tool, you need to enable an [ID mapping for your segmentation](./segmentation_mappings.md) to load the super-voxel graph. Once WEBKNOSSOS detects this, the proofreading tool can be activated on the toolbar (clipboard icon):
30-31: Grammar/clarity nits.Fix “If case” and preposition “right of”.
-If case you want to reload, hide or remove a 3D mesh during proofreading, you can use the context menu in the 3D viewport by hovering the mesh. You can enable and disable the automatic mesh loading by toggling the respective button in the toolbar, right of the proofreading tool button. +If you want to reload, hide, or remove a 3D mesh during proofreading, use the context menu in the 3D viewport by hovering the mesh. You can enable or disable automatic mesh loading by toggling the respective button in the toolbar, to the right of the proofreading tool button.docs/publications.md (1)
272-272: Standardize DOI link and spacing; use canonical doi.org URLUse the DOI resolver and add a space after "DOI:". This also aligns with nearby entries.
- [Neuron Volume 87, Issue 6 (2015) DOI:10.1016/j.neuron.2015.09.003.](https://www.sciencedirect.com/science/article/pii/S0896627315007606) + [Neuron 87(6) (2015). DOI: 10.1016/j.neuron.2015.09.003](https://doi.org/10.1016/j.neuron.2015.09.003)docs/users/password.md (2)
49-55: Optional: add a one-liner example for token usage.Consider a brief hint to reduce context switching, e.g., “Export WEBKNOSSOS_TOKEN and the library will pick it up,” or link to that section directly.
55-55: Link confirmed — standardize token terminologyLinked Python docs are canonical and document token usage. docs/users/password.md uses "Authentication Token" (heading) but the paragraph calls it a "personal access token (API key)"; pick one term and make it consistent across docs (suggest "Personal Access Token (PAT)" or consistently "Authentication token"). Location: docs/users/password.md lines 51–55.
docs/tasks_projects/index.md (2)
5-5: Fix pluralization.Change "project" → "projects".
Apply this diff:
-In the following page, we'll go through the [concepts](concepts.md) used for task and project management in WEBKNOSSOS, and explain how to create [tasks](tasks.md) and [project](projects.md). +In the following page, we'll go through the [concepts](concepts.md) used for task and project management in WEBKNOSSOS, and explain how to create [tasks](tasks.md) and [projects](projects.md).
8-8: Add a caption/title to the video embed to leverage the new captions feature.Provide a descriptive title so it renders as a caption.
Apply this diff:
- +docs/ui/keyboard_shortcuts.md (1)
206-206: Capitalize “Classic controls” consistently.Match earlier capitalization in this section.
Apply this diff:
-With classic controls, several mouse controls are modifier-driven and may also use the right-click for actions, such as erasing volume data. +With Classic controls, several mouse controls are modifier-driven and may also use the right-click for actions, such as erasing volume data.docs/tasks_projects/concepts.md (1)
11-11: Add a caption/title to the video embed for consistency with captioned media.Use a descriptive title to render a caption.
Apply this diff:
- +docs/users/index.md (1)
9-9: Consider standardizing bullet point format.The bullet point was changed from
-to+for "Account and password", which creates inconsistency with the other list items that still use-. Based on the search results, this configuration adds the ability to align images, add captions to images (rendering them as figures), and mark large images for lazy-loading, but this change doesn't appear related to the image caption functionality.Apply this diff to maintain consistent bullet formatting:
-- [Account and password](password.md) +- [Account and password](password.md)docs/terminology.md (1)
49-49: Redundant line replacement detected.The line "Sometimes this is also referred to as a super-voxel graph." was replaced with an identical line, creating a no-op change. This appears to be an unnecessary diff that doesn't contribute to the PR's objective of adding image captions.
Consider reverting this change as it doesn't add value and may have been introduced accidentally during the formatting updates.
docs/index.md (1)
60-60: Minor grammar consistency and stray duplicate earlier on page.
- Line 60 is fine. While here, there’s a small duplicate “and and” in Features (Line 21) — recommend fixing.
Would you like me to sweep the Features list for similar small nits?
docs/data/zarr_stream.md (1)
16-18: Caption is fine; fix a preceding incomplete sentence.Line 14 reads like a fragment. Suggest:
Due to the nature of the Zarr spec, you need to individually copy a URL for each WEBKNOSSOS layer.docs/data/upload_python.md (1)
2-2: Prefer “library” over “lib” for consistency/tone.Apply:
-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. +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 library.docs/ui/toolbar.md (1)
6-8: Typo: “und” → “and” in caption (and consider updating the alt text above as well).Apply:
- The WEBKNOSSOS toolbar contains many useful features for quick access such as Saving und Undo/Redo + The WEBKNOSSOS toolbar contains many useful features for quick access such as Saving and Undo/RedoAlso consider fixing the same “und” in the image alt text on Line 5 for consistency.
docs/data/zarr.md (2)
144-144: Trim trailing space in code snippet.
Minor style nit in “def main() -> None: ”.Apply:
-def main() -> None: +def main() -> None:
171-176: Clarify when 3D downsampling is appropriate (anisotropy caveat).
To avoid misleading users with strongly anisotropic Z spacing, suggest qualifying the bullet.-- Use 3D downsampling +- Use 3D downsampling (prefer 2D in-plane downsampling if your data are strongly anisotropic in z)docs/connectome_viewer.md (1)
15-17: LGTM: caption block reads well.
Optional: to reduce redundancy for screen readers, consider shortening the image alt text since the caption already carries the full sentence.docs/datasets/organization.md (1)
22-22: Make shortcut instruction OS-agnostic.
Small UX polish to include macOS modifier.-To move multiple datasets to a folder at once, you can make use of multi-selection. As in typical file explorers, CTRL + left click adds individual datasets to the current selection. Shift + left click selects a range of datasets. +To move multiple datasets to a folder at once, you can use multi-selection. As in typical file explorers, Ctrl (Cmd on macOS) + left click adds individual datasets to the current selection. Shift + left click selects a range of datasets.docs/getting_started.md (1)
105-105: Fix missing space in sentenceThere’s no space before the link.
-Please contact us at [[email protected]](mailto:[email protected]) or[write a post in the WEBKNOSSOS support forum](https://forum.image.sc/tag/webknossos) +Please contact us at [[email protected]](mailto:[email protected]) or [write a post in the WEBKNOSSOS support forum](https://forum.image.sc/tag/webknossos)docs/proofreading/split_segments_toolkit.md (1)
34-34: Minor punctuation/consistencyConsider ending list items with periods for consistency (neighboring bullets end with periods).
docs/datasets/settings.md (3)
31-31: Stray exclamation mark at end of paragraphDrop the trailing “!”.
-... without having to edit the dataset's value here (which they might not have the permissions for).! +... without having to edit the dataset's value here (which they might not have the permissions for).
94-94: Grammar: “a dataset”Fix article usage.
-Deleting an dataset will not delete any annotations associated with it. +Deleting a dataset will not delete any annotations associated with it.
3-3: Optional: pluralize “permission”Reads slightly better as “permissions.”
-You can configure the metadata, permission, and other properties of a dataset at any time. +You can configure the metadata, permissions, and other properties of a dataset at any time.docs/automation/jobs.md (1)
36-36: Minor style tweakAdd a comma for readability.
-In case you run into any trouble please [contact us](mailto:[email protected]). +In case you run into any trouble, please [contact us](mailto:[email protected]).docs/data/export_ui.md (1)
16-19: Caption added correctly; align terminologyUse “TIFF” consistently and brand as “WEBKNOSSOS.”
-The "Download" dialog for exporting and downloading annotations and dataset layers. WebKnossos offers downloads as Tif stacks, the native WEBKNOSSOS file formats, and through the Python library. +The "Download" dialog for exporting and downloading annotations and dataset layers. WEBKNOSSOS offers downloads as TIFF stacks, the native WEBKNOSSOS file formats, and through the Python library.docs/meshes/working_with_meshes.md (2)
3-3: Broken Markdown link (extra bracket)There’s an extra “]” before the closing parenthesis.
-... ([Read more in this blog series](https://medium.com/scalableminds/how-to-make-great-videos-for-biomedical-microscopy-data-51218ffa2421)]). +... ([Read more in this blog series](https://medium.com/scalableminds/how-to-make-great-videos-for-biomedical-microscopy-data-51218ffa2421)).
15-15: Capitalize “3D” consistently-... the context menu in the 3d viewport ... +... the context menu in the 3D viewport ...docs/ui/index.md (1)
20-20: Fix typographical error in caption.The caption contains "draging" which should be "dragging".
Apply this diff to fix the typo:
-Customizing the layout by draging and resizing the viewports. +Customizing the layout by dragging and resizing the viewports.docs/data/concepts.md (1)
27-27: Fix grammatical error in caption.The caption contains "Color contain the microscopy data and and segmentation layers" with a duplicated "and" and missing article.
Apply this diff to fix the grammar:
-Color contain the microscopy data and and segmentation layers contain (volume) annotations or masks. +Color layers contain the microscopy data and segmentation layers contain (volume) annotations or masks.docs/volume_annotation/segments_list.md (1)
19-19: Redundant line change detected.The file shows Line 19 as modified, but the content appears identical to what it was before. This might be a formatting artifact or unnecessary change.
docs/tutorial_volume_annotation.md (1)
62-62: Redundant line change detected.Similar to the other file, Line 62 shows as modified but the content appears unchanged. This could be a whitespace or line ending change that serves no functional purpose.
docs/dashboard/datasets.md (1)
14-17: Caption added correctly; consider differentiating alt text vs. caption for a11y.Alt text (Line 14) and caption (Lines 15–17) are identical. Prefer concise, descriptive alt text and use the caption for additional context to avoid redundancy for screen‑reader users.
docs/dashboard/tasks.md (1)
10-12: Fix grammar in caption (“Task” → “Tasks”).Use the plural to match the subject.
-Tasks can be distributed to users. Task can include rich instructions. +Tasks can be distributed to users. Tasks can include rich instructions.Also mirror the fix in the image alt text on Line 9.
docs/skeleton_annotation/import_export.md (1)
11-13: Use straight quotes/backticks instead of acute accents around “Download”.The text uses ´Download´ (acute accent) instead of straight quotes or backticks. Prefer
"Download"orDownloadfor consistency and searchability.Also applies to: 17-19
docs/skeleton_annotation/index.md (1)
21-23: LGTM: good use of captions.Optional: consider adding a caption for the YouTube embed on Line 26 for consistency across media.
docs/skeleton_annotation/modes.md (1)
8-10: Captions added consistently across modes; a couple of small nits.
- Some sentences use double spaces after periods (e.g., Lines 25 and 35). Prefer single spaces for consistency.
- Consider ending captions with periods for uniform style.
Also applies to: 27-31, 37-40, 45-57
docs/skeleton_annotation/trees_list.md (1)
28-31: Multi‑paragraph caption: verify rendering.This caption spans two lines/paragraphs. Ensure your MkDocs/Material “caption” block renders multi‑paragraph captions as intended; otherwise, consider condensing to one line.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (78)
docs/automation/ai_segmentation.md(1 hunks)docs/automation/alignment.md(1 hunks)docs/automation/animations.md(1 hunks)docs/automation/index.md(1 hunks)docs/automation/jobs.md(1 hunks)docs/connectome_viewer.md(2 hunks)docs/dashboard/annotations.md(1 hunks)docs/dashboard/datasets.md(1 hunks)docs/dashboard/featured_publications.md(1 hunks)docs/dashboard/index.md(1 hunks)docs/dashboard/tasks.md(1 hunks)docs/data/concepts.md(4 hunks)docs/data/export_python.md(1 hunks)docs/data/export_ui.md(1 hunks)docs/data/image_stacks.md(1 hunks)docs/data/index.md(1 hunks)docs/data/n5.md(1 hunks)docs/data/neuroglancer_precomputed.md(1 hunks)docs/data/streaming.md(1 hunks)docs/data/upload_python.md(1 hunks)docs/data/upload_ui.md(1 hunks)docs/data/wkw.md(1 hunks)docs/data/zarr.md(2 hunks)docs/data/zarr_stream.md(1 hunks)docs/datasets/composing.md(1 hunks)docs/datasets/external_storage.md(1 hunks)docs/datasets/index.md(1 hunks)docs/datasets/organization.md(1 hunks)docs/datasets/settings.md(5 hunks)docs/faq.md(1 hunks)docs/getting_started.md(3 hunks)docs/index.md(1 hunks)docs/meshes/index.md(1 hunks)docs/meshes/loading_meshes.md(1 hunks)docs/meshes/precomputed_meshes.md(1 hunks)docs/meshes/working_with_meshes.md(1 hunks)docs/open_source/dataset_handling.md(1 hunks)docs/open_source/installation.md(3 hunks)docs/proofreading/index.md(1 hunks)docs/proofreading/merger_mode.md(1 hunks)docs/proofreading/proofreading_tool.md(1 hunks)docs/proofreading/segmentation_mappings.md(0 hunks)docs/proofreading/split_segments_toolkit.md(2 hunks)docs/publications.md(1 hunks)docs/sharing/dataset_sharing.md(3 hunks)docs/sharing/index.md(1 hunks)docs/skeleton_annotation/comments.md(1 hunks)docs/skeleton_annotation/import_export.md(3 hunks)docs/skeleton_annotation/index.md(1 hunks)docs/skeleton_annotation/modes.md(2 hunks)docs/skeleton_annotation/operations.md(2 hunks)docs/skeleton_annotation/tools.md(1 hunks)docs/skeleton_annotation/trees_list.md(3 hunks)docs/tasks_projects/concepts.md(1 hunks)docs/tasks_projects/index.md(1 hunks)docs/tasks_projects/projects.md(1 hunks)docs/tasks_projects/tasks.md(3 hunks)docs/terminology.md(1 hunks)docs/today_i_learned.md(1 hunks)docs/tutorial_automation.md(1 hunks)docs/tutorial_data_sharing.md(1 hunks)docs/tutorial_volume_annotation.md(1 hunks)docs/ui/index.md(1 hunks)docs/ui/keyboard_shortcuts.md(1 hunks)docs/ui/object_info.md(1 hunks)docs/ui/status_bar.md(1 hunks)docs/ui/toolbar.md(3 hunks)docs/users/access_rights.md(1 hunks)docs/users/index.md(1 hunks)docs/users/new_users.md(3 hunks)docs/users/organizations.md(1 hunks)docs/users/password.md(1 hunks)docs/users/teams.md(2 hunks)docs/volume_annotation/import_export.md(1 hunks)docs/volume_annotation/index.md(1 hunks)docs/volume_annotation/pen_tablets.md(1 hunks)docs/volume_annotation/segments_list.md(1 hunks)docs/volume_annotation/segments_statistics.md(1 hunks)
💤 Files with no reviewable changes (1)
- docs/proofreading/segmentation_mappings.md
🧰 Additional context used
🧠 Learnings (1)
📚 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
🔇 Additional comments (68)
docs/proofreading/index.md (1)
9-9: LGTM—content unchanged.This preserves meaning and aligns with the surrounding list items.
docs/today_i_learned.md (1)
11-11: LGTM: whitespace cleanupRemoving the trailing blank lines after the closing figure tag is fine and should not affect rendering.
docs/meshes/precomputed_meshes.md (1)
9-9: docs/automation/jobs.md exists but heading mismatch — update link or page title; clarify admin access.
- docs/automation/jobs.md is present but does not contain an H1 "Processing Jobs". Confirm the correct page title and either update the link text to match it or change the page heading to "Processing Jobs".
- If the Jobs page is restricted, add a short note that access requires admin permissions.
Likely an incorrect or invalid review comment.
docs/data/export_python.md (1)
5-5: Tighten phrasing; apply wording tweak (link verified).File: docs/data/export_python.md — Lines: 5-5
Apply wording tweak:
-There are also quick start instructions for Python download available directly from the [WEBKNOSSOS UI](./export_ui.md). +There are also quick‑start instructions for downloading data via Python available directly in the [WEBKNOSSOS UI](./export_ui.md).Verified ./export_ui.md exists at docs/data/export_ui.md.
docs/automation/animations.md (1)
47-47: Fix link anchor and normalize "bounding box" casingThe anchor ../ui/toolbar.md#measurement-tools does not exist — update the link to ../ui/toolbar.md (or to a correct heading) and standardize casing: use lowercase "bounding box" for generic references and use the exact UI label "Bounding Box Tool" only when referring to the toolbar control. (docs/automation/animations.md:47)
Likely an incorrect or invalid review comment.
docs/datasets/external_storage.md (1)
10-10: Use a proper YouTube embed (or thumbnail link) and add an accessible caption.Material for MkDocs (with pymdownx.blocks.caption or Material’s caption support) allows captions on block content — including iframes. Wrap the iframe in a
with a (include markdown="1" so Markdown-in-HTML is processed), or use a linked YouTube thumbnail.Option A – iframe + caption:
- +<figure markdown> + <iframe + width="560" + height="315" + src="https://www.youtube.com/embed/yYauIHZcI_4" + title="External datastores in WEBKNOSSOS" + loading="lazy" + allowfullscreen + ></iframe> + <figcaption>External datastores in WEBKNOSSOS</figcaption> +</figure>Option B – thumbnail image linked to YouTube:
- +[](https://www.youtube.com/watch?v=yYauIHZcI_4)Confirm which caption mechanism is enabled in the site config (pymdownx.caption / Material captions) and whether Markdown-in-HTML (markdown="1") is allowed in the build.
docs/automation/alignment.md (1)
8-8: LGTM – link and formatting look good.docs/open_source/dataset_handling.md (1)
39-39: LGTM – closing fence/newline fix is correct.docs/data/index.md (1)
17-17: LGTM – clear pointer to dataset settings.docs/ui/status_bar.md (1)
7-7: LGTM – minor EOF formatting only.docs/tutorial_automation.md (1)
61-61: LGTM – closing sentence reads well.docs/sharing/index.md (1)
24-24: LGTM! YouTube video embedded correctly.The YouTube video embed is properly formatted and follows the expected syntax for WEBKNOSSOS documentation.
docs/data/wkw.md (1)
76-76: LGTM! Trailing newline added for consistency.Adding a trailing newline at the end of the file improves consistency with other documentation files and follows common markdown conventions.
docs/datasets/composing.md (1)
14-14: LGTM! Video formatting improved.Removing the empty line after the YouTube video embed creates cleaner formatting that's consistent with the overall documentation style improvements in this PR.
docs/automation/index.md (1)
5-5: LGTM! YouTube video embedded correctly.The YouTube video embed follows the proper syntax and aligns with the documentation improvements in this PR.
docs/data/image_stacks.md (1)
111-111: LGTM! Trailing newline added for consistency.Adding a trailing newline at the end of the file maintains consistency with markdown best practices and aligns with the formatting improvements across the documentation in this PR.
docs/datasets/index.md (1)
38-38: LGTM! DOI link formatting maintained correctly.The DOI link formatting remains consistent and properly structured. This change preserves the existing link format while maintaining the documentation improvements introduced in this PR.
docs/meshes/loading_meshes.md (1)
7-17: Captions look good and match MkDocs Material syntax.Consistent use of “/// caption … ///” after images. No issues found.
docs/meshes/index.md (1)
10-12: LGTM on caption addition.Reads well and aligns with the pattern used elsewhere.
docs/skeleton_annotation/tools.md (1)
86-87: Tip block is helpful and correctly linked.Nice cross‑reference to the shortcuts guide.
docs/tutorial_data_sharing.md (1)
60-60: EOF newline fix—good.No content changes; formatting is improved.
docs/ui/toolbar.md (2)
86-88: Caption reads well.Consistent style; no issues.
137-137: Paragraph addition LGTM.Clear guidance; link target looks correct.
docs/data/n5.md (1)
38-38: LGTM: unchanged semantics; formatting consistent.docs/data/upload_ui.md (1)
55-55: LGTM: bullet-to-paragraph fix improves rendering.docs/data/neuroglancer_precomputed.md (1)
44-44: LGTM: performance bullet formatting aligned with other pages.docs/datasets/organization.md (1)
18-20: LGTM: caption addition improves accessibility.docs/ui/object_info.md (1)
68-68: LGTM: paragraph rendering reads better than a stray list item.docs/users/new_users.md (3)
7-9: LGTM: caption improves context for the invite dialog.
29-31: LGTM: caption for Teams & Permissions dialog.
43-43: LGTM: closing sentence reads clearly.docs/connectome_viewer.md (1)
42-42: Fix broken mailto link (remove extra slashes).
Change to mailto:[email protected] — confirm in a local preview that it opens the mail client.-The connectome file format is under active development and experiences frequent changes. [Please reach out to us for the latest file format spec and configuration help](mailto://[email protected]). +The connectome file format is under active development and experiences frequent changes. [Please reach out to us for the latest file format spec and configuration help](mailto:[email protected]).docs/tasks_projects/projects.md (1)
14-16: LGTM on caption usageThe new caption block is correctly placed right after the image and matches the Material for MkDocs “/// caption … ///” pattern.
docs/getting_started.md (1)
29-32: Captions added correctlyAll three caption blocks look good and follow the expected syntax.
Also applies to: 38-41, 76-79
docs/users/teams.md (1)
10-12: Good, consistent captionsBoth caption blocks are correctly applied and helpful for context.
Also applies to: 26-29
docs/proofreading/split_segments_toolkit.md (1)
22-25: Caption placement is correctThe caption clearly explains the flood‑fill pitfall; formatting looks correct.
docs/datasets/settings.md (1)
33-36: Solid use of captions across sectionsAll five images now have consistent captions; nice improvement for accessibility.
Also applies to: 55-58, 68-71, 84-87, 96-99
docs/automation/jobs.md (1)
31-34: Caption looks goodCaption matches the image and follows the new syntax.
docs/meshes/working_with_meshes.md (2)
11-13: Caption is clear and helpfulNicely explains what the Segments tab offers.
17-17: LGTM on the noteThe cross-link to animations is helpful.
docs/tasks_projects/tasks.md (1)
48-50: LGTM! Consistent image caption formatting applied.The caption blocks follow the documented MkDocs Material format using triple slash delimiters, enabling proper figure and figcaption rendering. The captions are descriptive and align well with the content they describe.
Also applies to: 64-66, 71-73, 81-83, 91-93, 142-144
docs/proofreading/merger_mode.md (1)
18-20: LGTM! Caption blocks properly added for both images.The caption formatting follows the correct syntax and provides clear descriptions for both the button and dialog images. The separation of the two images with individual captions improves documentation clarity.
Also applies to: 22-24
docs/sharing/dataset_sharing.md (2)
33-35: LGTM! Image captions enhance documentation clarity.The caption blocks are correctly formatted and provide meaningful descriptions that help users understand the UI elements shown in each screenshot. The captions effectively complement the existing documentation text.
Also applies to: 49-51, 65-67
70-70: Fix minor formatting issue with paragraph consolidation.The removal of the blank line before the recommendation sentence consolidates the information paragraph appropriately, but ensure the
infoadmonition styling remains intact.docs/ui/index.md (1)
12-14: LGTM! Caption implementation follows MkDocs standard.The caption blocks use the correct triple slash syntax for MkDocs Material, providing clear and descriptive text for both UI overview images.
Also applies to: 19-21
docs/data/concepts.md (3)
12-14: LGTM! Caption blocks enhance visual documentation.The caption blocks are properly formatted and provide clear descriptions of the technical concepts illustrated in each image. The content accurately describes the relationships between datasets, cubes, buckets, and downsampling concepts.
Also applies to: 26-28, 40-42
126-127: LGTM! Dataset metadata structure clarification.The update from a single
idfield to separateid.nameandid.teamfields provides clearer documentation structure and aligns with the actual JSON schema shown in the example. This improves understanding of the metadata specification.
206-206: LGTM! Appropriate formatting normalization.Converting the bullet point about deprecated JSON mappings to a regular note maintains the important information while improving document flow.
docs/open_source/installation.md (1)
59-61: LGTM! Comprehensive caption implementation for onboarding images.All onboarding and user management screenshots now have appropriate caption blocks that clearly describe their purpose. The captions effectively guide users through the installation and setup process.
Also applies to: 68-70, 88-90, 92-94, 112-114, 116-118
docs/automation/ai_segmentation.md (2)
20-22: LGTM! AI segmentation workflow captions improve user guidance.The caption blocks provide clear descriptions of the AI segmentation workflow steps, helping users understand the toolbar location, startup process, and job monitoring. The formatting is consistent with the MkDocs caption syntax.
Also applies to: 29-31, 33-35
43-43: LGTM! Content formatting cleanup.The removal of extra blank lines and consolidation of the contact information improves document flow while maintaining all important content.
docs/volume_annotation/index.md (1)
12-12: LGTM! Minor formatting adjustment.The line change appears to be a minor formatting normalization with no functional impact on the documentation content.
docs/dashboard/index.md (1)
11-11: LGTM! Clean formatting improvement.The removal of extra blank lines around the bullet point improves the document's formatting consistency.
docs/dashboard/featured_publications.md (1)
8-10: LGTM! Proper caption block syntax.The caption block follows the correct
/// captionsyntax pattern and provides meaningful descriptive text that enhances accessibility and user understanding.docs/volume_annotation/pen_tablets.md (1)
55-55: LGTM! Content positioning improvement.The sentence relocation maintains the same content while improving the flow and organization of the tutorial steps.
docs/dashboard/annotations.md (2)
10-16: LGTM! Consistent caption implementation.The caption blocks are properly formatted using the
/// captionsyntax and provide descriptive text that matches the image alt text. This enhances the documentation by providing proper image captions as supported by MkDocs Material.
22-22: Minor formatting improvement.The trailing sentence structure appears to have been refined for better readability.
docs/skeleton_annotation/comments.md (1)
5-8: LGTM! Proper image caption implementation.The caption block correctly follows the
/// captionsyntax and provides descriptive text that improves document accessibility and user comprehension.docs/volume_annotation/import_export.md (2)
19-19: LGTM! Minor content improvement.The sentence refinement improves clarity and flow of the documentation.
15-18: LGTM — caption formatting is consistent; verify MkDocs caption plugin is configured.
Search found numerous '/// caption' markers (e.g., docs/volume_annotation/import_export.md) but no mkdocs.yml/mkdocs.yaml or caption-plugin entries were detected; confirm mkdocs.yml lists mkdocs-caption (or an equivalent) in plugins and that the dependency is present in requirements.txt or pyproject.toml/setup.py.docs/skeleton_annotation/import_export.md (2)
33-36: LGTM: clear, matching caption.
49-55: LGTM: captions match the visuals and improve scannability.docs/volume_annotation/segments_statistics.md (1)
11-11: No content change detected; newline addition is fine.docs/skeleton_annotation/operations.md (3)
8-10: LGTM: caption renders the menu context clearly.
35-36: Numbered sub‑steps read better than prose—nice.Improves readability of split operations.
41-43: LGTM: descriptive caption helps clarify the animation.docs/skeleton_annotation/trees_list.md (2)
13-15: LGTM: caption aligns with surrounding text and image.
46-48: LGTM: strong, action‑oriented caption.
|
|
||
| - `Tree merging` works similarly to edge deletion but will create a new edge between two previously unconnected trees. Select the first node and right-click on a second one to choose _Create Edge & Merge with this Tree_. When using _Classic Controls_, the second node needs to be selected with _SHIFT + ALT + Left Click_ to create an edge between the two. | ||
|
|
||
|  |
Co-authored-by: Philipp Otto <[email protected]>
Co-authored-by: Philipp Otto <[email protected]>
Co-authored-by: Philipp Otto <[email protected]>
Co-authored-by: Philipp Otto <[email protected]>
This PR adds image captions to the webknossos documentation. We just enabled this
mkdocsfeatures in the wk-libs and this is the follow up here. Most captions were auto-extracted from the existing images title.Example
Steps to test:
Issues:
(Please delete unneeded items, merge only when none are left open)
$PR_NUMBER.mdfile inunreleased_changesor use./tools/create-changelog-entry.py)