Skip to content

docs: hide cometAPI bundle until release-1.7#10310

Merged
mendonk merged 1 commit into
mainfrom
docs-cometapi-for-release-1.7
Oct 17, 2025
Merged

docs: hide cometAPI bundle until release-1.7#10310
mendonk merged 1 commit into
mainfrom
docs-cometapi-for-release-1.7

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Oct 16, 2025

Hide CometAPI bundle until it is released in 1.7.

Summary by CodeRabbit

  • Documentation
    • Updated component documentation terminology throughout bundle descriptions and advanced integration examples for consistency.
    • Removed CometAPI bundle from the documentation sidebar navigation.

@mendonk mendonk requested a review from aimurphy October 16, 2025 21:20
@mendonk mendonk self-assigned this Oct 16, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Oct 16, 2025

Walkthrough

Documentation updates to the CometAPI bundle guide, replacing terminology references from "Smart Function" to "Smart Transform" in component descriptions, accompanied by removal of the corresponding sidebar entry from the documentation navigation structure.

Changes

Cohort / File(s) Summary
CometAPI Bundle Documentation
docs/docs/Components/_bundles-cometapi.mdx
Replaced two instances of "Smart Function" with "Smart Transform" in usage descriptions and advanced use cases sections.
Documentation Sidebar Configuration
docs/sidebars.js
Removed the "Components/bundles-cometapi" sidebar entry from the Bundles section under Components reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • #10003: Performs broader "Smart Function" → "Smart Transform" renaming across multiple bundle documentation and code metadata files.
  • #9735: Adds/introduces the Components/bundles-cometapi documentation file and sidebar entry that this PR removes.
  • #10141: Contains overlapping "Smart Function" and "Smart Transform" terminology changes across component bundle documentation files.

Suggested labels

documentation, size:S, lgtm, ignore-for-release

Suggested reviewers

  • erichare
  • edwinjosechittilappilly

Pre-merge checks and finishing touches

❌ Failed checks (2 inconclusive)
Check name Status Explanation Resolution
Test Quality And Coverage ❓ Inconclusive This pull request contains only documentation and configuration changes: updates to text in docs/docs/Components/_bundles-cometapi.mdx and removal of a sidebar entry in docs/sidebars.js. The shell script results confirm that no code implementations, API endpoints, async functions, or test files were added or modified in this PR. The custom check for "Test Quality and Coverage" is designed to evaluate tests for new code implementations, but this PR introduces no new functionality that would require testing. The custom check cannot be properly applied to this PR because the check criteria are designed for feature implementation pull requests with new code, async functions, API endpoints, and behavioral testing requirements. Since this PR is a documentation-only change (hiding CometAPI bundle documentation until release 1.7), the check instructions are not applicable. Consider applying this check only to PRs that introduce new implementations or code changes, or use a different check designed for documentation modifications.
Test File Naming And Structure ❓ Inconclusive The custom check requires verification of test file patterns and structure according to specific guidelines (backend tests with test_*.py naming, frontend tests with *.test.ts/tsx, integration tests, descriptive test names, setup/teardown structure, and edge case coverage). However, the PR contains only documentation changes to two files: docs/docs/Components/_bundles-cometapi.mdx and docs/sidebars.js. The shell script results confirm no test files are present in this PR's diff, making it impossible to apply the test file naming and structure verification criteria to these changes. This custom check is not applicable to the current PR since it contains only documentation changes with no test files to evaluate. If the intention is to verify that appropriate tests exist for the CometAPI bundle being hidden, that verification should be done separately or the check should be clarified to apply to documentation-only changes. Otherwise, this check cannot be meaningfully applied to assess the PR.
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "docs: hide cometAPI bundle until release-1.7" accurately captures the main objective of the changeset. The primary change is the removal of the CometAPI bundle entry from the sidebar navigation in docs/sidebars.js, which effectively hides the bundle from documentation navigation until the specified release version. The secondary change of updating text content in the bundle documentation file aligns with preparing the bundle for eventual release. The title is concise, specific, and clearly communicates to teammates that this PR controls the visibility of the CometAPI bundle documentation.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Test Coverage For New Implementations ✅ Passed This pull request contains exclusively documentation changes with no code implementations, bug fixes, or new features. The changes consist of renaming a documentation file by prefixing it with an underscore (a Docusaurus convention to hide documentation), removing its sidebar entry, and updating text references. The shell script verification confirms no test files exist in the PR and no code changes were made to functional source files. Since the test coverage check requirements explicitly apply only to new components, bug fixes, new features, and their corresponding tests, and this PR contains none of these elements, the check passes by design.
Excessive Mock Usage Warning ✅ Passed The shell script results confirm that this PR contains only two documentation files (docs/docs/Components/_bundles-cometapi.mdx and docs/sidebars.js) with no test files present. The custom check "Excessive Mock Usage Warning" is designed to evaluate test files for improper mock usage patterns, but there are no test files to review in this pull request. Since the check cannot be applied to non-test files, there is no relevant content to assess against the mock usage criteria.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs-cometapi-for-release-1.7

📜 Recent review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7dd37d4 and d7874b4.

📒 Files selected for processing (2)
  • docs/docs/Components/_bundles-cometapi.mdx (2 hunks)
  • docs/sidebars.js (0 hunks)
💤 Files with no reviewable changes (1)
  • docs/sidebars.js
🧰 Additional context used
📓 Path-based instructions (2)
docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

docs/**/*.{md,mdx}: All Markdown/MDX pages must start with front matter including at least title and description; include sidebar_position for docs pages when applicable
Code blocks must specify a language and may include a title (```lang title="…")
Use sentence case for headings and keep paragraphs short and scannable
Write in second person, present tense, with a professional but approachable tone
Use inline code with backticks for code terms; use bold for UI elements and italics for emphasis; keep lists in parallel structure
Ensure internal links are functional and navigation works (update cross-references as needed)
Verify all code examples in docs and blog actually run as shown
Use correct terminology capitalization: Langflow, Component, Flow, API, JSON
Reference images with absolute paths under /img/... and provide descriptive alt text

Files:

  • docs/docs/Components/_bundles-cometapi.mdx
docs/docs/**/*.{md,mdx}

📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)

Use Docusaurus admonitions (:::+tip|warning|danger) instead of custom callouts in docs pages

Files:

  • docs/docs/Components/_bundles-cometapi.mdx
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Test Docs Build / Test Docs Build
  • GitHub Check: build-and-deploy
🔇 Additional comments (3)
docs/docs/Components/_bundles-cometapi.mdx (3)

21-21: Terminology update to "Smart Transform" is consistent and clear.

The change from "Smart Function" to "Smart Transform" aligns with the component naming updates mentioned in the PR. The description remains clear and accurate in context.


58-58: Terminology update aligns with other changes.

The second "Smart Transform" reference maintains consistency across the document and provides accurate component guidance.


1-5: Verify that hiding mechanism is complete for release-gating goal.

The front matter is compliant with coding guidelines (title, description present). However, the PR objective is to "hide CometAPI bundle until release-1.7," and hiding appears to be implemented via sidebar removal (per the AI summary mentioning docs/sidebars.js changes, which are not shown in the provided files).

Consider whether a deprecation notice or "Coming Soon" banner should be added to this page content as an additional safeguard to prevent direct access via URL, or whether sidebar removal alone is sufficient for your release workflow.


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 Oct 16, 2025
@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 16, 2025

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

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Oct 16, 2025
@github-actions github-actions Bot added the lgtm This PR has been approved by a maintainer label Oct 17, 2025
@mendonk mendonk added this pull request to the merge queue Oct 17, 2025
Merged via the queue into main with commit 5c4b8be Oct 17, 2025
24 checks passed
@mendonk mendonk deleted the docs-cometapi-for-release-1.7 branch October 17, 2025 13:17
mokeyish pushed a commit to mokeyish/langflow that referenced this pull request Oct 21, 2025
korenLazar pushed a commit to kiran-kate/langflow that referenced this pull request Nov 13, 2025
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 lgtm This PR has been approved by a maintainer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants