Skip to content

docs: add windows desktop back for 1.5 release#8866

Merged
mendonk merged 2 commits into
mainfrom
lfoss-1521
Jul 10, 2025
Merged

docs: add windows desktop back for 1.5 release#8866
mendonk merged 2 commits into
mainfrom
lfoss-1521

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Jul 3, 2025

Add back the Langflow Desktop on Windows installation and handling C++ compiler requirements.

Summary by CodeRabbit

  • Documentation
    • Updated installation guide with separate tabs for macOS and Windows, providing detailed, OS-specific instructions.
    • Added a troubleshooting section for Windows users addressing C++ build tools requirements and guidance on resolving related errors.

@mendonk mendonk requested a review from aimurphy July 3, 2025 18:04
@mendonk mendonk self-assigned this Jul 3, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 3, 2025

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

The documentation was updated to provide OS-specific installation instructions for Langflow Desktop, introducing separate tabs for macOS and Windows. Additionally, a new troubleshooting section was added to address C++ build tool requirements for Windows installations. No changes were made to code or exported entities.

Changes

File(s) Change Summary
docs/docs/Get-Started/get-started-installation.md Added tabbed OS-specific installation instructions for macOS and Windows, including C++ tool notes.
docs/docs/Support/troubleshooting.md Added troubleshooting section for C++ build tool requirements on Windows.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs
    User->>Docs: Access installation guide
    alt macOS tab
        Docs-->>User: Show macOS installation steps
    else Windows tab
        Docs-->>User: Show Windows installation steps
        alt C++ compiler missing
            Docs-->>User: Show C++ build tools troubleshooting
        end
    end
Loading

Possibly related PRs

Suggested labels

documentation, size:L, lgtm

Suggested reviewers

  • aimurphy
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch lfoss-1521

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.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 3, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 3, 2025

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

@dosubot dosubot Bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jul 3, 2025
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🧹 Nitpick comments (2)
docs/docs/Get-Started/get-started-installation.md (2)

34-38: Minor wording & grammar: “install wizard” → “installation wizard”

install wizard uses install as a noun; the usual phrasing is installation wizard or setup wizard.

-4. Double-click the downloaded `.msi` file, and then use the install wizard to install Langflow Desktop.
+4. Double-click the downloaded `.msi` file, and then use the installation wizard to install Langflow Desktop.

45-50: Duplicate quick-start sentence

The sentence “After confirming that Langflow is running, create your first flow …” appears inside each tab and once again after the closing </Tabs> block. Consider deleting the outer copy to avoid redundancy.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b1ae5e4 and c4a1fde.

📒 Files selected for processing (2)
  • docs/docs/Get-Started/get-started-installation.md (2 hunks)
  • docs/docs/Support/troubleshooting.md (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`docs/docs/**/*.{md,mdx}`: All documentation content must be placed within the '...

docs/docs/**/*.{md,mdx}: All documentation content must be placed within the 'docs/' directory, organized into subdirectories such as 'getting-started', 'components', 'integrations', 'administration', 'contributing', and 'api-reference'.
All documentation markdown files must start with a frontmatter block containing at least 'title' and 'description' fields.
Use admonitions (:::tip, :::warning, :::danger) in markdown files to highlight important information, warnings, or critical issues.
Reference images in documentation using the '/img/' path and provide descriptive alt text in markdown.
Use code blocks with language identifiers and optional titles for code examples in markdown documentation.
Documentation content must follow the style guide: professional but approachable tone, second person voice, present tense, short paragraphs, sentence case headers, inline code with backticks, bold for UI elements, italic for emphasis, and parallel structure in lists.
Use consistent terminology: always capitalize 'Langflow', 'Component', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.

📄 Source: CodeRabbit Inference Engine (.cursor/rules/docs_development.mdc)

List of files the instruction was applied to:

  • docs/docs/Support/troubleshooting.md
  • docs/docs/Get-Started/get-started-installation.md
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.667Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize 'Langflow', 'Component', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: All terminology such as 'Langflow', 'Component', 'Flow', 'API', and 'JSON' must be capitalized or uppercased as specified in the terminology section.
docs/docs/Get-Started/get-started-installation.md (2)
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: When writing documentation for Langflow using Docusaurus, always use professional but approachable tone, second person voice for instructions, and present tense for current features.
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-30T14:40:02.667Z
Learning: Applies to docs/docs/**/*.{md,mdx} : Use consistent terminology: always capitalize 'Langflow', 'Component', and 'Flow' when referring to Langflow concepts; always uppercase 'API' and 'JSON'.
🪛 LanguageTool
docs/docs/Get-Started/get-started-installation.md

[grammar] ~37-~37: The word ‘install’ is not a noun.
Context: ...ownloaded .msi file, and then use the install wizard to install Langflow Desktop. ...

(A_INSTALL)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: build-and-deploy

Comment thread docs/docs/Support/troubleshooting.md
Comment thread docs/docs/Get-Started/get-started-installation.md
Copy link
Copy Markdown
Collaborator

@aimurphy aimurphy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but can we merge or add this to the 1.5 branch so everything is on one branch?

@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label Jul 3, 2025
@mendonk mendonk added this pull request to the merge queue Jul 10, 2025
@mendonk mendonk removed this pull request from the merge queue due to a manual request Jul 10, 2025
@mendonk mendonk enabled auto-merge July 10, 2025 15:31
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jul 10, 2025
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 10, 2025

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

@mendonk mendonk added this pull request to the merge queue Jul 10, 2025
Merged via the queue into main with commit afb8201 Jul 10, 2025
13 checks passed
@mendonk mendonk deleted the lfoss-1521 branch July 10, 2025 15:47
smatiolids pushed a commit to smatiolids/langflow-dev that referenced this pull request Jul 10, 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 size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants