docs: Repurpose Concepts section to focus on the visual editor and flows by aimurphy · Pull Request #8845 · langflow-ai/langflow

aimurphy · 2025-07-03T03:38:49Z

Closes LFOSS-1395, LFOSS-1529, LFOSS-1530, and LFOSS-1532

You don't need to review all files. Only 10 have substantial changes. Preview and diff links are given below:

Update intro messaging:
- Welcome page: Quick refresh as a hold-over before the new design is implemented. (Diff)
- Add About Langflow/What is Langflow page. (Diff)
- Slight adjustments to the install page to differentiate the install options, add the missing install from source option, and streamline some steps and similar content. (Diff)
- Add more next steps and address some minor duplication in the quickstart. (Diff)
Rename the Concepts section to Flows.
Change Langflow overview page to Use the visual editor, and focus the content on the visual editor. (Diff)
Update and expand the flow-specific pages:
- Rename Flows to Build flows and describe how to create and manage flows. Provide some guidance on running flows (more to come in a future PR). (Diff)
- Create an Import and export flows page to contain all information about importing and exporting flows. (Diff)
- Combine the Embedded Chat Widget page with the Publish flows page, rewrite the page, and rename it to Share and embed flows. (Diff)
Minor edit to the Docker deployment intro to avoid confusing that quickstart with the actual Langflow quickstart page. (Diff)
Correct the instructions for storing credentials in Global variables. (Diff)
Handle redundancies across concepts pages and related pages.
Update links as needed.
Align terminology and update outdated terminology as needed.
- Use Langflow repository or Langflow codebase to refer to the overall Langflow application project, instead of Langflow project, which could be confused with the Project terminology within Langflow.

Summary by CodeRabbit

Documentation
- Added new pages introducing Langflow and explaining import/export of flows.
- Extensively rewrote and reorganized core documentation for building, managing, sharing, and embedding flows, with improved guides and visual aids.
- Enhanced and clarified instructions for installation, API key management, global variables, Docker deployment, and MCP server usage.
- Updated and restructured the sidebar for better navigation and discoverability.
- Fixed minor typos, improved link accuracy, and standardized terminology throughout.
- Removed and consolidated outdated or redundant documentation pages.

coderabbitai · 2025-07-03T03:38:56Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

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 update extensively revises, restructures, and expands the Langflow documentation. Major changes include new and reorganized conceptual guides, improved installation and quickstart instructions, clarified API and embedding documentation, and enhanced sidebar navigation. Numerous editorial updates standardize terminology and link references. No code or API signatures are modified; all changes are documentation-only.

Changes

File(s)	Change Summary
docs/docs/API-Reference/api-build.md, ...api-files.md, ...api-flows-run.md, ...api-flows.md	Updated API docs: clarified references, fixed links, improved step numbering, and refined payload formatting.
docs/docs/API-Reference/api-projects.md, ...api-reference/api-build.md	Linked "projects" to Langflow projects section for clarity.
docs/docs/Agents/agents-tools.md, ...agents.md	Fixed image alt text, minor textual and formatting edits.
docs/docs/Components/mcp-client.md	Updated projects section link in MCP component description.
docs/docs/Concepts/concepts-components.md	Added intro about editing components in code and visual editor.
docs/docs/Concepts/concepts-file-management.md	Added section referencing API for file management.
docs/docs/Concepts/concepts-flows-import.md	New page: detailed guide on importing/exporting flows, JSON structure, and related methods.
docs/docs/Concepts/concepts-flows.md	Rewritten: now a comprehensive user guide for building, managing, and running flows; removed JSON internals.
docs/docs/Concepts/concepts-overview.md	Rewritten: focuses on practical visual editor usage, workspace gestures, and flow testing; removed prior details.
docs/docs/Concepts/concepts-playground.md, ...concepts-voice-mode.md	Renamed title, added TODO comments for future consolidation.
docs/docs/Concepts/concepts-publish.md	Rewritten/expanded: covers API, embedding, MCP servers, playground sharing, and multi-framework integration.
docs/docs/Concepts/embedded-chat-widget.md	Deleted: content merged into concepts-publish.md and sidebar updated accordingly.
docs/docs/Concepts/mcp-server.md	Clarified MCP server/project linkage, reworded instructions, fixed step numbering.
docs/docs/Configuration/configuration-api-keys.md	Clarified UI steps for API key/global variable management, expanded instructions.
docs/docs/Configuration/configuration-authentication.md, ...custom-database.md, ...environment-variables.md	Editorial: "project" → "repository" for clarity in file references.
docs/docs/Configuration/configuration-global-variables.md	Clarified UI navigation, improved formatting for environment variable confirmation steps.
docs/docs/Contributing/contributing-bundles.md, ...community.md, ...github-issues.md	Editorial: "project" → "repository" or "codebase"; clarified responsibility for issue tracking.
docs/docs/Deployment/deployment-docker.md	Improved clarity, structure, and flow in Docker deployment guide.
docs/docs/Develop/develop-application.md, ...overview.md, ...install-custom-dependencies.md, ...memory.md, ...webhook.md	Updated links, terminology, and references for consistency and clarity.
docs/docs/Get-Started/about-langflow.md	New: Introductory "What is Langflow?" page.
docs/docs/Get-Started/get-started-installation.md	Restructured: improved clarity, navigation, and organization of installation options.
docs/docs/Get-Started/get-started-quickstart.md	Improved clarity, link references, and structure; expanded next steps.
docs/docs/Get-Started/welcome-to-langflow.md	Streamlined introduction, removed detailed sections, focused on navigation to start/contribution pages.
docs/docusaurus.config.js	Reformatted redirect arrays for readability; added redirect for embedded chat widget doc.
docs/sidebars.js	Sidebar: explicit doc objects/labels, new "About Langflow", reorganized flows section, removed chat widget doc.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Langflow Docs (UI)
    participant API Reference
    participant Embedding Guide

    User->>Langflow Docs (UI): Navigates sidebar or search
    Langflow Docs (UI)->>API Reference: Shows API usage, endpoints, links to flow/project IDs
    Langflow Docs (UI)->>Embedding Guide: Shows embedding instructions, widget config, integration steps
    User->>Langflow Docs (UI): Follows links for install, quickstart, or concepts
    Langflow Docs (UI)->>User: Provides step-by-step guides and conceptual overviews

Possibly related PRs

docs: v2/files does not work for images #8512: Updates API documentation to clarify image upload support and endpoint usage, related to the documentation updates in this PR regarding file upload endpoints and references.

Suggested labels

documentation, size:XXL, lgtm

Suggested reviewers

mendonk
edwinjosechittilappilly

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch lfoss-1529

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.