Skip to content

Conversation

@mendonk
Copy link
Collaborator

@mendonk mendonk commented Nov 19, 2025

#10587

Summary by CodeRabbit

  • Documentation
    • Restructured component documentation into individual pages for better navigation and clarity.
    • Renamed "File" component to "Read File" and "Smart Function" to "Smart Transform" throughout documentation.
    • Reorganized component references with updated internal links to reflect new documentation structure.
    • Added dedicated documentation pages for core components, data processors, and workflow tools.

✏️ Tip: You can customize this high-level summary in your review settings.

@mendonk mendonk requested a review from aimurphy November 19, 2025 21:46
@mendonk mendonk self-assigned this Nov 19, 2025
@mendonk mendonk changed the base branch from main to docs-1.7-release November 19, 2025 21:46
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 19, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

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.

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

Walkthrough

This pull request performs a comprehensive documentation restructure, converting consolidated component documentation pages into individual component-focused pages, updating cross-references throughout the docs, renaming "Smart Function" to "Smart Transform," and migrating "File" to "Read File." Additionally, file path references are updated from the backend path to the new lfx path structure.

Changes

Cohort / File(s) Summary
Deleted Consolidated Pages
docs/docs/Components/components-data.mdx, components-logic.mdx, components-processing.mdx
Removed comprehensive consolidated component documentation files that previously covered Data, Logic, and Processing components together
New Individual Data Component Pages
docs/docs/Components/api-request.mdx, directory.mdx, news-search.mdx, read-file.mdx, rss-reader.mdx, sql-database.mdx, url.mdx, web-search.mdx, webhook.mdx
Added individual documentation pages for each data component, replacing the consolidated components-data.mdx
New Individual Processing/Logic Component Pages
docs/docs/Components/batch-run.mdx, data-operations.mdx, dataframe-operations.mdx, if-else.mdx, llm-router.mdx, loop.mdx, notify-and-listen.mdx, parser.mdx, python-interpreter.mdx, run-flow.mdx, smart-router.mdx, smart-transform.mdx, split-text.mdx, structured-output.mdx, type-convert.mdx, write-file.mdx
Added individual documentation pages for processing and logic components, replacing consolidated pages
New Utility Component Pages
docs/docs/Components/calculator.mdx, current-date.mdx, dynamic-create-data.mdx, mock-data.mdx
Added documentation for utility components
I/O and Helper Component Documentation Reorganization
docs/docs/Components/chat-input-and-output.mdx, message-history.mdx, text-input-and-output.mdx, legacy-core-components.mdx
Reorganized I/O and helper components documentation, with renamed pages and consolidated legacy components reference
Updated API Reference Documentation
docs/docs/API-Reference/api-files.mdx, api-flows-run.mdx, api-monitor.mdx
Updated internal links and component references (File → Read File, webhook path updates)
Updated Agent Documentation
docs/docs/Agents/agents.mdx, agents-tools.mdx, mcp-server.mdx
Updated navigation links and MCP-related documentation
Updated Bundle Documentation
docs/docs/Components/bundles-*.mdx (30+ files)
Updated all bundle pages with new component link targets, "Smart Transform" terminology, and "Read File" references
Updated Components Overview
docs/docs/Components/components-agents.mdx, components-bundles.mdx, components-custom-components.mdx, components-embedding-models.mdx, components-models.mdx, components-prompts.mdx, components-tools.mdx, concepts-components.mdx
Updated component overview pages with new link targets and component references
Updated Development/Deployment Documentation
docs/docs/Contributing/contributing-bundles.mdx, contributing-component-tests.mdx, contributing-components.mdx, docs/docs/Deployment/deployment-docker.mdx
Updated file paths from backend structure to new lfx path structure
Updated Feature Documentation
docs/docs/Develop/api-keys-and-authentication.mdx, concepts-file-management.mdx, data-types.mdx, logging.mdx, memory.mdx, session-id.mdx
Updated internal links and removed deprecated component references
Updated Flow/Workflow Documentation
docs/docs/Flows/concepts-playground.mdx, concepts-publish.mdx, webhook.mdx
Updated navigation links and component references throughout flow documentation
Updated Getting Started and Release Notes
docs/docs/Get-Started/get-started-quickstart.mdx, docs/docs/Support/release-notes.mdx, troubleshooting.mdx
Updated template descriptions and added v1.7.0 release notes with component and feature changes
Updated Tutorials
docs/docs/Tutorials/agent.mdx
Updated component links in tutorial documentation

Sequence Diagram(s)

Not applicable—this is a documentation-only refactor with no runtime behavior or control-flow changes.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Rationale: While the volume of files modified is substantial (50+), the changes follow highly consistent patterns (link updates, naming conventions, path migrations). Review complexity is moderate due to:

  • High repetition of similar updates across many bundle files
  • Straightforward link/path substitutions following predictable rules
  • New documentation content is self-contained per file
  • Risk of inconsistencies or missed updates due to scale

Areas requiring attention:

  • Verify all link targets (old anchors → new individual pages) are correctly updated across 50+ modified documentation files and no broken internal links remain
  • Confirm new component documentation pages (read-file.mdx, smart-transform.mdx, etc.) have complete and accurate parameter tables and descriptions
  • Check that bundle documentation updates properly reference Smart Transform instead of Smart Function consistently
  • Validate that path updates from /components-data#*, /components-processing#*, /components-helpers#*, /components-io#*, /components-logic#* to new routes are comprehensive and correct
  • Ensure legacy component references and redirection guidance are properly documented in legacy-core-components.mdx

Possibly related PRs

Suggested labels

documentation, lgtm

Suggested reviewers

  • aimurphy

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Test File Naming And Structure ❓ Inconclusive This PR is a repository initialization with no test file changes, making the test file naming and structure check not applicable. Check is not applicable to documentation and infrastructure-only PRs. Apply to future PRs containing test files ensuring they follow established patterns: backend tests use test_*.py with pytest, frontend tests use *.test.ts/tsx or tests directories with Playwright.
✅ Passed checks (6 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs: add altk reflection component' accurately describes the main change: adding documentation for the ALTK reflection component, as evidenced by the docs/docs/Components/bundles-altk.mdx addition in the raw summary.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Test Coverage For New Implementations ✅ Passed PR consists entirely of documentation changes (.mdx files) with no source code modifications; test coverage requirements do not apply to documentation-only updates.
Test Quality And Coverage ✅ Passed This PR contains only documentation changes (.mdx files); no code implementations, APIs, or functionality requiring test coverage.
Excessive Mock Usage Warning ✅ Passed PR is documentation-only change to bundles-altk.mdx with no test files or code modifications, making mock usage check not applicable.

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 documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Nov 19, 2025
@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 Nov 19, 2025
@github-actions github-actions bot added the lgtm This PR has been approved by a maintainer label Nov 19, 2025
@github-actions github-actions bot removed the documentation Improvements or additions to documentation label Nov 20, 2025
@mendonk mendonk merged commit 16c1176 into docs-1.7-release Nov 20, 2025
20 checks passed
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 20, 2025
@mendonk mendonk deleted the docs-atlk-more-features branch November 20, 2025 16:41
@github-actions
Copy link
Contributor

github-actions bot commented Nov 20, 2025

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

@mendonk mendonk mentioned this pull request Nov 20, 2025
2 tasks
github-merge-queue bot added a commit that referenced this pull request Dec 18, 2025
* langflow-webhook-auth-enable

* add-not-contains-filter-operator

* does-not-contains-operator

* less-redundant-explanation

* docs: add jq and path selection to data operations (#10083)

add-jq-and-path-to-data-operations

* smart transform historical names

* change back to smart transform

* jq expression capitalization/package name

* small edit for clarity of not contains operator

* read/write file component name changes

* docs: add smart router component (#10097)

* init

* add-to-release-notes

* remove-dynamic-output-as-parameter

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: screenshot audit (#10166)

* remove-unused

* agent-examples

* main-ui-screenshots

* components-screenshots

* combine-web-search-components

* simple-agent-flow-in-playground

* round-screenshots

* my-projects

* combine-data-components

* docs: component paths updates for lfx (#10130)

* contributing-bundles-path

* api-monitor-example

* concepts-components-page

* contribute-components-path

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: auto-add projects as MCP servers  (#10096)

* add-mcp-auto-auth-as-default-behavior

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>
Co-authored-by: Edwin Jose <[email protected]>

* docs: amazon bedrock converse (#10289)

* use-bedrock-converse

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

* Update docs/docs/Components/bundles-amazon.mdx

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs 1.7 release: add mock data component (#10288)

* add-component-and-release-note

* Apply suggestion from @aimurphy

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: update custom component docs (#10323)

* add-partial

* update-lfx-component-paths

* move-partial

* completed-quickstart

* clean up intro

* try-docker-with-custom-mount

* up-to-typed-annotations

* typed-annotations

* dynamic-fields

* end-of-file

* bundles-naming

* chore: update component index

---------

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>

* docs: add cometapi back for 1.7 release (#10445)

* add-comet-bundle-back-for-1.7

* add-comet-to-release-notes

* docs: add back docling remote vlm for release 1.7 (#10489)

* add-back-docling-vlm-content

* add-release-note

* docs: ALTK component (#10511)

* broken-anchor

* sidebar-and-page

* add-release-note

* add-context-on-output

* docs: SSRF warning (#10573)

* add-ssrf-protection-env-var

* api-request-component

* Update docs/docs/Components/components-data.mdx

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* move-note-to-table

* release-note

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: dynamic create data component (#10517)

* add-dynamic-create-data-component-and-release-note

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* clarify-message-types

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: cuga component bundle (#10589)

* initlal-content

* cuga-specific-component-connections

* cleanup

* use-the-same-name

* add-lite-mode-remove-api-flag-and-mode

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* public-or-private-internet

* agent-doesnt-check-urls

* peer-review

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: remove docling vlm component from 1.7 release branch (#10630)

remove-vlm-component

* docs: rename component categories and make all components single pages (#10648)

* docs: OpenAPI spec version upgraded from 1.6.5 to 1.6.8 (#10627)

Co-authored-by: github-merge-queue <[email protected]>
Co-authored-by: Mendon Kissling <[email protected]>

* up to models and agents

* sidebars

* fix-broken-links

* chore: Fix indentation on bundles-docling.mdx (#10640)

* sidebars

* redo-intros

* link-to-models

* data-components

* files-components-no-kb

* io-components

* helper-utility-components

* llm-ops-components

* logic-components

* processing-pages

* sidebars

* combine-legacy-components-into-one-page

* update-links

* remove-overview-pages-and-redirect

* make-mcp-tools-page

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* no-cap

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-merge-queue <[email protected]>
Co-authored-by: April I. Murphy <[email protected]>

* docs: combined web search component (#10664)

* combine-pages

* remove-rss-and-news-search-and-update-links

* remove-vlm-link

* leave-old-release-note-but-remove-link

* docs: add altk reflection component (#10660)

* add-new-component

* differentiate-components

* docs: mcp streamable http client (#10621)

* release note

* mcp-client-changes

* update-astra-example

* icons-and-copy

* order-of-names

* docs: add cuga decomposition strategy as advanced parameter (#10672)

* update-component-link

* init

* add-decomp-as-advanced-param

* [autofix.ci] apply automated fixes

* [autofix.ci] apply automated fixes (attempt 2/3)

* [autofix.ci] apply automated fixes (attempt 3/3)

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* update-component-index

* [autofix.ci] apply automated fixes

* [autofix.ci] apply automated fixes (attempt 2/3)

* [autofix.ci] apply automated fixes (attempt 3/3)

---------

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
Co-authored-by: April I. Murphy <[email protected]>

* docs: datastax bundles page (#10686)

* init

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: llm router changed to llm selector (#10663)

* update-component-name

* previous-name-and-release-note

* [autofix.ci] apply automated fixes

* [autofix.ci] apply automated fixes (attempt 2/3)

* [autofix.ci] apply automated fixes (attempt 3/3)

* docs: log alembic to stdout (#10711)

* docs-alembic-log-env-var

* cleanup

* remove-legacy-component-link

* docs: configure s3 for file storage backend (#10678)

* configure-file-storage-s3

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* clarify-s3-credentials

* add-storage-tags-and-cleanup-creds-seciton

* role-link-name

* fix-parse-error

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: clarify docling components (#10722)

* clarify-what-docling-components-do

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* component-name

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: legacy processing components for 1.7 (#10661)

* make-components-legacy

* remove-broken-link

* remove-outdated-components

* release-notes

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* add-back-dynamic-create-data

* fix-broken-link-in-smart-router

* remove-release-note

* Apply suggestions from code review

* legacy

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: remove dataframe to toolset component (#10854)

remove-df-to-toolset-component

* docs: clarify superuser flow run behavior (#10865)

superuser-clarification

* docs: add composio components (#10868)

more-composio-components

* docs: additional dependencies for running Docling in Linux-based Docker environments (#10861)

* initial-partial-and-troubleshooting

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: change component h3 headings to h2 (#10886)

bump-headings

* docs: include webhook request example with auth (#10885)

* include-webhook-request-examples

* fix-build-error

* docs: configurable api key validation (#10882)

* initial-content

* clarify-differences

* typo

* docs: langflow server supports streamable http (#10891)

* initial-updates

* check-params

* server-params

* peer-review

* update-release-note

* remove-delete-endpoint-for-legacy

* Revert "docs: langflow server supports streamable http (#10891)"

This reverts commit e1dbefc.

* docs: new registration endpoints, email form, and telemetry events (#10816)

* add-email-telemetry

* add-registration-v2-endpoints-and-telemetry

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* changes-from-peer-review

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: more info on smart router component (#10916)

* continue-example

* remove-duplicate-info

* match-by-route-name

* docs: sidebars release notes (#10949)

* move-to-support-section

* support

* docs: update comet api component parameters (#10950)

update-parameters

* docs: mcp server streamable http (#10955)

* content

* transport

* add-back-webhook-env-var

* Update docs/docs/Components/bundles-cuga.mdx

* docs: use bootstrap instead of deprecated launchctl load (#10951)

use-bootstrap-and-semicolons

* docs: lfx serve and lfx run (#10498)

* add-content

* add-entry-to-release-notes

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

* partial-for-dependencies

* clarify-api-key-and-uvx

* lfx-included

* add-lfx-schema-and-cleanup-table

* install-nightly-curl-flow-json-clarify-dependencies-create-local-api-key

* not-automatic

* code-review

* work-in-progress

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: authorization changes (#10992)

* files-superuser

* get-config-endpoint-requires-api-key

* config-endpoint

* remove-parentheticals

* docs: custom components input types (#11027)

* io-links-and-update-paths

* remove-unncessary-sentence

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* docs: cuga bundle updates (#10998)

* change-policies-to-instructions

* new-screenshot

* Apply suggestions from code review

Co-authored-by: April I. Murphy <[email protected]>

---------

Co-authored-by: April I. Murphy <[email protected]>

* files-when-knowldge-is-not-enabled

* docs: revert lfx (#11065)

revert-lfx

* docs: cuga model limits (#11064)

* add-warning

* remove-params

* add-watsonx-model

* bump-api-version

---------

Co-authored-by: April M <[email protected]>
Co-authored-by: Edwin Jose <[email protected]>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-merge-queue <[email protected]>
Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>
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.

3 participants