Skip to content

docs(bundles): install shapes, override rule, bundle_api_version#13578

Draft
erichare wants to merge 2 commits into
bundles/shims-auditfrom
bundles/docs
Draft

docs(bundles): install shapes, override rule, bundle_api_version#13578
erichare wants to merge 2 commits into
bundles/shims-auditfrom
bundles/docs

Conversation

@erichare

@erichare erichare commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Bundle Separation Phase A — PR 10: docs (install shapes, override rule, bundle_api_version)

Part of Bundle Separation Phase A — metapackage split (1.11). The final PR of the original 10-PR plan; stacked on the shim-contract PR (bundles/shims-audit) so the documented shim wording matches the contract-tested one.

What this documents (the deliberately small rule surface)

docs/docs/Develop/extensions-overview.mdx

  • Two install stories: pip install langflow (everything, same as today) and pip install lfx (engine only, bring your own bundles)
  • The invariant: a component's identity is its bundle name, never its distribution — ext:<bundle>:<Class>@official is stable across packaging moves
  • Updated package table: the lfx-bundles metapackage (per-provider extras + generated [all]), the 5 partner packages, the 4 pilots
  • Legacy import paths: the shim behavior, the locked ModuleNotFoundError wording (matching the PR 7 contract tests), and the migration recipe for direct lfx users (switch to lfx[bundles] or pin lfx-<provider> packages)
  • Override rule: "ship a manifest — a manifest always wins", with the precedence chain and the bundle-shadowed warning
  • bundle_api_version: the single compat number; partners declare lfx.compat: ["1"]; manifest-less packages ride their PEP 508 lfx pin; no version arithmetic across the lfx / lfx-bundles / lfx-<provider> lines

docs/docs/Deployment/deployment-lfx-compatibility.mdx

  • lfx[bundles] as a headless/serverless deployment footnote (not a getting-started headline): engine + lfx-bundles[all], the slimmer per-provider alternative, and the intentional absence of lfx[all]

Test plan

  • MDX-safe (no unbackticked angle brackets — <provider> shapes are all inline code)
  • Content cross-checked against the implemented surface: extras names, shim wording, precedence order, lfx.compat shape

Stack

Base bundles/shims-audit (PR 7). Full merge order: #13563#13564#13568#13573#13576#13577 → this (with #13565 / #13566 / #13567 hanging off their parents). Draft until QA signs off.

Documents the deliberately small user-facing rule surface of the metapackage
split (1.11):

- extensions-overview.mdx: the two install stories (pip install langflow =
  everything, same as today; pip install lfx = engine only, bring your own
  bundles); the bundle-name-is-identity invariant; the current package table
  (lfx-bundles metapackage + the 5 partner packages + the 4 pilots); the
  legacy-import shim behavior with the locked ModuleNotFoundError wording and
  the migration recipe for direct lfx users (switch to lfx[bundles] or pin
  lfx-<provider> packages); the override rule ("ship a manifest -- a manifest
  always wins", with the bundle-shadowed warning); bundle_api_version as the
  single compat number (lfx.compat ["1"]; manifest-less packages ride their
  PEP 508 lfx pin) and the no-version-arithmetic rule.
- deployment-lfx-compatibility.mdx: lfx[bundles] as the headless/serverless
  deployment footnote (engine + lfx-bundles[all]; slimmer per-provider
  alternative; intentionally no lfx[all]).

Both files verified MDX-safe (no unbackticked angle brackets).
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: a4f3d843-4494-46c1-b072-e8aa6fde3bc4

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch bundles/docs

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jun 9, 2026
@github-actions

This comment has been minimized.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 9, 2026
@github-actions

This comment has been minimized.

1 similar comment
@github-actions

github-actions Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Build successful! ✅
Deploying docs draft.
Deploy successful! View draft

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant