Add Annotation to key features and standardize docs URLs#7282
Add Annotation to key features and standardize docs URLs#7282
Conversation
WalkthroughUpdated README.md: replaced legacy documentation URLs (those under https://voxel51.com/docs/fiftyone/ and related paths) with new https://docs.voxel51.com/ equivalents across the site header, Getting Started guides, Tutorials, virtualenv/install guide, Docker instructions, quickstart dataset/app/session links, and the documentation resources table (guides, tutorials, recipes, user guide, API, CLI). Added a new "Native Annotation" key-features bullet with its corresponding docs link and an additional image asset URL. Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Line 423: Replace the bare HTML TODO comment "<!-- TODO: add annotation demo
video here -->" in README.md with a traceable reference: either a markdown
checklist item or a comment that includes the GitHub issue/PR number (e.g., "Add
annotation demo video — see issue #<n>") so follow-up is tracked; update the
TODO text to include the issue link or checklist checkbox and short context so
maintainers can find and close the task later.
- Line 417: The heading's inline HTML image tag is missing an alt attribute
which breaks accessibility linting; update the <img ...> element used in the
"key features" heading to include an appropriate alt attribute (for decorative
use, set alt="") so the markdown header image satisfies accessibility
requirements—locate the <img> in the heading line and add alt="".
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: de78194e-49cb-4f0d-8a28-5e8dcb56252c
📒 Files selected for processing (1)
README.md
|
|
||
| <div id='key-features'> | ||
|
|
||
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑 |
There was a problem hiding this comment.
Add alt attribute to the heading image to satisfy accessibility lint.
<img ...> is missing alt text. For decorative usage, set alt="".
Suggested fix
-## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑
+## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px" alt=""> key features 🔑📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑 | |
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px" alt=""> key features 🔑 |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 417-417: Images should have alternate text (alt text)
(MD045, no-alt-text)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 417, The heading's inline HTML image tag is missing an alt
attribute which breaks accessibility linting; update the <img ...> element used
in the "key features" heading to include an appropriate alt attribute (for
decorative use, set alt="") so the markdown header image satisfies accessibility
requirements—locate the <img> in the heading line and add alt="".
README.md
Outdated
| Create and edit 2D and 3D labels directly in the App or integrate with your | ||
| favorite annotation tools — all in one platform. | ||
|
|
||
| <!-- TODO: add annotation demo video here --> |
There was a problem hiding this comment.
🧹 Nitpick | 🔵 Trivial
Track the TODO with an issue link to prevent drift.
Replace the bare TODO with a GitHub issue reference (or checklist item) so the demo-video follow-up is traceable.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` at line 423, Replace the bare HTML TODO comment "<!-- TODO: add
annotation demo video here -->" in README.md with a traceable reference: either
a markdown checklist item or a comment that includes the GitHub issue/PR number
(e.g., "Add annotation demo video — see issue #<n>") so follow-up is tracked;
update the TODO text to include the issue link or checklist checkbox and short
context so maintainers can find and close the task later.
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
README.md (1)
417-417:⚠️ Potential issue | 🟡 MinorMissing alt attribute on heading image.
The heading's
<img>tag lacks an alt attribute, breaking accessibility linting. Setalt=""for decorative images.♿ Proposed fix
-## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑 +## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px" alt=""> key features 🔑🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 417, The heading image tag is missing an alt attribute which fails accessibility linting; update the <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> element in the README heading (the key features heading) to include alt="" (an empty alt for decorative images) so the linter recognizes it as decorative and resolves the accessibility error.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 419-421: The README contains a spelling mistake in the sentence
under the Annotation section: change the word "interate" to "iterate" so the
line reads "...then curate, QA, and iterate all in one platform."; update the
text near the Annotation heading in README.md (the paragraph referencing 2D and
3D labels) to correct the typo.
---
Duplicate comments:
In `@README.md`:
- Line 417: The heading image tag is missing an alt attribute which fails
accessibility linting; update the <img
src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png"
height="20px"> element in the README heading (the key features heading) to
include alt="" (an empty alt for decorative images) so the linter recognizes it
as decorative and resolves the accessibility error.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 7d15c7a5-a154-44c5-9862-166a0d5af8c5
📒 Files selected for processing (1)
README.md
There was a problem hiding this comment.
♻️ Duplicate comments (2)
README.md (2)
417-417:⚠️ Potential issue | 🟡 MinorAdd
altattribute to heading image (Line 417) to satisfy MD045.Use
alt=""if decorative.Proposed fix
-## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑 +## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px" alt=""> key features 🔑🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` at line 417, The heading image tag on the README (the <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> element) is missing an alt attribute which triggers MD045; update that tag to include an appropriate alt attribute (use alt="" if the image is purely decorative) so the markdown linter passes.
419-421:⚠️ Potential issue | 🟡 MinorFix typo in Native Annotation copy (Line 421).
interateshould beiterate.Proposed fix
- favorite annotation tools — then curate, QA, and interate all in one platform. + favorite annotation tools — then curate, QA, and iterate all in one platform.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@README.md` around lines 419 - 421, Update the typo in the README.md text under the "Native Annotation" section by replacing the misspelled word "interate" with the correct spelling "iterate"; locate the sentence that reads "then curate, QA, and interate all in one platform." and change "interate" to "iterate" so the line reads "then curate, QA, and iterate all in one platform."
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@README.md`:
- Line 417: The heading image tag on the README (the <img
src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png"
height="20px"> element) is missing an alt attribute which triggers MD045; update
that tag to include an appropriate alt attribute (use alt="" if the image is
purely decorative) so the markdown linter passes.
- Around line 419-421: Update the typo in the README.md text under the "Native
Annotation" section by replacing the misspelled word "interate" with the correct
spelling "iterate"; locate the sentence that reads "then curate, QA, and
interate all in one platform." and change "interate" to "iterate" so the line
reads "then curate, QA, and iterate all in one platform."
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 315fdc67-ecce-4308-8b5f-0a8c7e8df234
📒 Files selected for processing (1)
README.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@README.md`:
- Around line 419-424: Move the "Native Annotation" block (the "**[Native
Annotation:]**" heading and its paragraph plus the trailing asset URL) so it
appears between the "Advanced Data Curation" and "Rich Integrations" sections;
locate the current "**[Native Annotation:]**" text in README.md and cut/paste
that entire block to immediately follow the "Advanced Data Curation" section
header and content and before the "Rich Integrations" header, preserving the
formatting and the asset URL.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: 70906479-b88d-4d85-9fc4-b3e1f338b03a
📒 Files selected for processing (1)
README.md
| - **[Native Annotation:](https://docs.voxel51.com/user_guide/annotation.html)** | ||
| Create and edit 2D and 3D labels directly in the App or integrate with your | ||
| favorite annotation tools — then curate, QA, and iterate, all in one platform. | ||
|
|
||
| https://github.com/user-attachments/assets/b06bcdac-d64f-4465-8668-12007dc0eeaa | ||
|
|
There was a problem hiding this comment.
Place Native Annotation in the intended slot.
This block is currently above “Visualize Complex Datasets”, but the PR objective says it should sit between Advanced Data Curation and Rich Integrations. Please move this section to that position.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@README.md` around lines 419 - 424, Move the "Native Annotation" block (the
"**[Native Annotation:]**" heading and its paragraph plus the trailing asset
URL) so it appears between the "Advanced Data Curation" and "Rich Integrations"
sections; locate the current "**[Native Annotation:]**" text in README.md and
cut/paste that entire block to immediately follow the "Advanced Data Curation"
section header and content and before the "Rich Integrations" header, preserving
the formatting and the asset URL.
There was a problem hiding this comment.
it's positioned as the leading block, which is what the PR summary states...check your carrots bro
There was a problem hiding this comment.
@Burhan-Q, you're right — my mistake. The "Native Annotation" block is intentionally the leading feature, and the placement in the diff is correct. I was misreading the PR summary. Apologies for the noise!
🧠 Learnings used
Learnt from: brimoor
Repo: voxel51/fiftyone PR: 5933
File: docs/source/tutorials/cvat_annotation.ipynb:172-172
Timestamp: 2025-05-22T16:09:42.240Z
Learning: When updating documentation links from voxel51.com/docs/fiftyone/ to docs.voxel51.com/, the "fiftyone/" segment should be dropped from the URL path, as voxel51.com/docs/fiftyone redirects to docs.voxel51.com (not docs.voxel51.com/fiftyone).
Burhan-Q
left a comment
Burhan-Q
left a comment
There was a problem hiding this comment.
A few minor notes, but otherwise looks like a solid update 🤘
| [](https://discord.gg/fiftyone-community) | ||
| [](https://huggingface.co/Voxel51) | ||
| [](https://share.hsforms.com/1zpJ60ggaQtOoVeBqIZdaaA2ykyk) | ||
| [](https://www.linkedin.com/company/voxel51) | ||
| [](https://medium.com/voxel51) |
There was a problem hiding this comment.
| [](https://discord.gg/fiftyone-community) | |
| [](https://huggingface.co/Voxel51) | |
| [](https://share.hsforms.com/1zpJ60ggaQtOoVeBqIZdaaA2ykyk) | |
| [](https://www.linkedin.com/company/voxel51) | |
| [](https://medium.com/voxel51) | |
| <div align="center"> | |
| <p align="center"> | |
| <!-- prettier-ignore --> | |
| [](https://discord.gg/fiftyone-community) | |
| [](https://huggingface.co/Voxel51) | |
| [](https://share.hsforms.com/1zpJ60ggaQtOoVeBqIZdaaA2ykyk) | |
| [](https://www.linkedin.com/company/voxel51) | |
| [](https://medium.com/voxel51) | |
| </p> | |
| </div> |
There was a problem hiding this comment.
Centering might look better. Although I wonder if we should duplicate these here since they're already at the top? I certainly don't mind, but not clear to me if the duplication is necessary or helpful.
| - **[Native Annotation:](https://docs.voxel51.com/user_guide/annotation.html)** | ||
| Create and edit 2D and 3D labels directly in the App or integrate with your | ||
| favorite annotation tools — then curate, QA, and iterate, all in one platform. | ||
|
|
||
| https://github.com/user-attachments/assets/b06bcdac-d64f-4465-8668-12007dc0eeaa | ||
|
|
There was a problem hiding this comment.
it's positioned as the leading block, which is what the PR summary states...check your carrots bro
|
|
||
| <div id='key-features'> | ||
|
|
||
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑 |
There was a problem hiding this comment.
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px"> key features 🔑 | |
| ## <img src="https://user-images.githubusercontent.com/25985824/106288517-2422e000-6216-11eb-871d-26ad2e7b1e59.png" height="20px" alt="Voxel51 logo"> key features 🔑 |
There was a problem hiding this comment.
to satisfy the rabbit and/or linter
3 participants
Summary
voxel51.com/docs/fiftyone/...todocs.voxel51.com/...Details
Annotation entry:
URL standardization: 12 occurrences of the legacy
voxel51.com/docs/fiftyonepattern replaced with the canonicaldocs.voxel51.compattern. Both resolve today, but this prevents future breakage if the redirect is removed.Summary by CodeRabbit