Migrating zoo/brain docs to top-level

[brimoor]

Summary by CodeRabbit

• Documentation Updates
  • Corrected the naming of "FiftyOne-Brain" to "FiftyOne Brain" for clarity.
  • Added hyperlinks to the FiftyOne Brain GitHub repository in the documentation.
  • Introduced detailed sections for "Dataset Zoo" and "Model Zoo," including code examples for usage.
  • Updated navigation links to reflect new documentation structure.
  • Implemented redirect mappings for user guides and tutorials to enhance accessibility.
  • Removed outdated callout items from the user guide.

[coderabbitai]

Walkthrough

The pull request introduces several updates to the documentation of the FiftyOne framework. Key changes include typographical corrections, the addition of hyperlinks, and the introduction of new sections for the "Dataset Zoo" and "Model Zoo." Additionally, several redirects have been implemented to maintain accessibility to reorganized content, while some outdated callout items have been removed for a streamlined user guide.

Changes

File	Change Summary
README.md	Renamed "FiftyOne-Brain" to "FiftyOne Brain."
docs/source/brain.rst	Added hyperlink to the FiftyOne Brain GitHub repository.
docs/source/index.rst	Added sections for "Dataset Zoo" and "Model Zoo" with descriptions and code examples; updated navigation links.
docs/source/integrations/albumentations.rst	Changed quickstart dataset reference to a structured internal reference format.
docs/source/redirects	Added new redirect mappings for user guides and tutorials; renamed certain HTML files.
docs/source/user_guide/index.rst	Removed custom callout items for "FiftyOne Dataset Zoo," "FiftyOne Model Zoo," and "FiftyOne Brain."

Possibly related PRs

• Add documentation for Elasticsearch vector DB integration #4431: The changes in this PR involve updates to the documentation for the FiftyOne Brain, specifically adding a new entry for the Elasticsearch backend in the user guide, which relates to the overall documentation improvements in the main PR.

Suggested reviewers

• mwoodson1

Poem

In the garden of code, we hop and play,
With links and sections brightening the way.
FiftyOne's wisdom, now clearer to see,
A rabbit's delight, as spry as can be! 🐇✨
Let's celebrate changes, both big and small,
In our documentation, we cherish them all!

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a9acf18 and 076778a.

Files selected for processing (1)

• docs/source/index.rst (3 hunks)

Additional comments not posted (3)

docs/source/index.rst (3)

383-409: Excellent addition of the Dataset Zoo section!

The new Dataset Zoo section provides a clear introduction to its capabilities and includes a helpful code example. This addition enhances the documentation by highlighting a key feature of FiftyOne.

---

411-447: Great addition of the Model Zoo section!

The new Model Zoo section effectively introduces its capabilities and includes a detailed code example. This addition significantly improves the documentation by showcasing another important feature of FiftyOne.

---

482-483: Navigation links updated correctly

The navigation links have been appropriately updated to include the new Dataset Zoo and Model Zoo sections. This ensures easy access to the new content.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[benjaminpkane]

Structure changes LGTM