Skip to content

Conversation

@abey79
Copy link
Member

@abey79 abey79 commented Dec 13, 2025

Related

What

  • Cleanup migration guide
  • Fix existing docs
  • Sneak a deprecation in the viewer event stuff

@github-actions
Copy link

github-actions bot commented Dec 13, 2025

Latest documentation preview deployed successfully.

Result Commit Link
18e28ad https://landing-bu380pssh-rerun.vercel.app/docs

Note: This comment is updated whenever you push a commit.

@abey79 abey79 changed the title misc fix + lint Update docs and migration guide for the catalog API updates Dec 15, 2025
@abey79 abey79 added 📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md labels Dec 15, 2025
@abey79 abey79 requested a review from ntjohnson1 December 15, 2025 09:27
@abey79 abey79 marked this pull request as ready for review December 15, 2025 09:27
@ntjohnson1 ntjohnson1 requested a review from Copilot December 15, 2025 18:27
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates documentation and the migration guide to reflect recent catalog API changes, primarily the renaming of "partition" terminology to "segment" and a comprehensive overhaul of the catalog module APIs. The changes consolidate the migration guide into a more structured format and update code examples to use the new API patterns.

  • Consolidated catalog API migration guide with clearer categorization
  • Updated documentation examples to use new method names (get_dataset(), datasets(), etc.)
  • Added deprecation decorator for partition_id property in viewer events

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
rerun_py/rerun_sdk/rerun/event.py Adds deprecated partition_id property to maintain backward compatibility while transitioning to segment_id
docs/content/reference/migration/migration-0-28.md Major restructuring of migration guide with consolidated sections for catalog API changes, clearer categorization, and updated code examples
docs/content/getting-started/data-out/query-data.md Updates code examples to use new API methods and patterns (e.g., get_dataset(), datasets(), DatasetView)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

### Blueprints

## Python SDK: blueprint APIs simplified
The updated APIs now abstracted from the underlying storage mechanism (blueprint datasets).
Copy link

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Corrected 'now abstracted' to 'are now abstracted' for grammatical correctness.

Suggested change
The updated APIs now abstracted from the underlying storage mechanism (blueprint datasets).
The updated APIs are now abstracted from the underlying storage mechanism (blueprint datasets).

Copilot uses AI. Check for mistakes.
Copy link
Member

@ntjohnson1 ntjohnson1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Added copilot review in case there was a typo or something. Looks pretty clear.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📖 documentation Improvements or additions to documentation exclude from changelog PRs with this won't show up in CHANGELOG.md

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants