SK-3118: Fix root README for the unary-only FlowVault SDK - #279
Merged
Merged
Conversation
The repo landing page was stale: it showed flowvault importing as `skyflow_flowvault` (it imports as `skyflow`), described it as "high-throughput bulk + unary" (bulk has been removed — it is unary only), and used the retired "Flow DB" name. Correct the import name and description, rename Flow DB -> FlowVault, and align the page structure with the Java repo's root README (add Documentation and Reporting a Vulnerability sections; note that both artifacts share the `skyflow` import and can't coexist in one environment). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Follow the skyflow-java root README structure: title + intro + CI/release/license badges, a "Which package do I want?" table (Package / Artifact / README / Vault Type / Version line), the independent-versioning note, repository layout, Documentation, and Reporting a Vulnerability. Vault types are named SkyVault and FlowVault. Also keeps the Python-specific note that both artifacts share the `skyflow` import and must be installed one per environment. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
yaswanth-pula-skyflow
approved these changes
Sep 16, 2026
skyflow-bharti
approved these changes
Sep 16, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The repo landing page (
README.md) was out of date after the FlowVault SDK went unary-only. This corrects it and aligns its structure with the skyflow-java root README (same monorepo-index shape).Fixes
import skyflow_flowvault→ corrected toimport skyflow(the package's top-level module isskyflow).skyflowimport and can't share one environment.Structure (aligned to Java)
All linked paths verified to exist (
docs/migrate_to_v2.md,CHANGELOG.md, both SDK READMEs andsamples/dirs).🤖 Generated with Claude Code