docs: Build out Troubleshooting and Support documentation#8662
Conversation
dosubot
Bot
added
the
size:XL
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis update restructures and expands the Langflow documentation. It reorganizes community and support guides, adds a comprehensive troubleshooting page, clarifies installation and dependency management, and updates sidebar navigation and redirects. The changes remove redundant or outdated sections, improve clarity, and provide more detailed instructions for users and contributors. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Docs
participant GitHub
participant Community
User->>Docs: Access installation/support/contributing docs
Docs-->>User: Provide updated instructions and troubleshooting
User->>GitHub: Star/watch repo, submit issues/discussions
User->>Community: Engage via suggested channels
GitHub-->>User: Send notifications (if watched/starred)
Community-->>User: Respond to questions/discussions
Possibly related PRs
Suggested labels
✨ Finishing Touches🧪 Generate Unit Tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
Documentation and Community
|
github-actions
Bot
added
documentation
|
Build successful! ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (9)
docs/docs/Contributing/contributing-community.md (1)
32-35: Consider rephrasing for formal documentation style.While the content is valuable, consider rephrasing for more formal documentation style.
-You can also submit feature requests and get help with Langflow through the GitHub repository. +You can also submit feature requests and get help using Langflow through the GitHub repository.docs/docs/Contributing/contributing-github-issues.md (4)
12-12: Remove extraneous comma
The comma in “bugs, and feature requests” is unnecessary.-The [Issues page in the Langflow repository](https://github.com/langflow-ai/langflow/issues) is actively updated with bugs, and feature requests. +The [Issues page in the Langflow repository](https://github.com/langflow-ai/langflow/issues) is actively updated with bugs and feature requests.
14-20: Correct grammar in tip section
Change “Before you report a bug or submitting a feature request” to “Before you report a bug or submit a feature request”.-Before you report a bug or submitting a feature request, search for existing similar issues. +Before you report a bug or submit a feature request, search for existing similar issues.
32-37: Fix markdown list indentation
Sub-list items are indented by 3 spaces; should be 2 spaces to satisfy markdownlint MD007.-* **Include snippets of the code that failed**: ... - * If your submission includes long sections... +* **Include snippets of the code that failed**: ... + * If your submission includes long sections...
38-41: Align sub-list indentation
Indent the nested bullets under “Be kind” by 2 spaces, not 3, to match markdownlint expectations.-* **Be kind**: Although bugs can be frustrating with any software, remember that your messages are read by real people who want to help. - * Your issues and discussions are attached to your GitHub account, and they can be read by anyone on the internet, including current and potential employers and colleagues. - * The Langflow repository is a public GitHub repository and, therefore, subject to the [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct). +* **Be kind**: Although bugs can be frustrating with any software, remember that your messages are read by real people who want to help. + * Your issues and discussions are attached to your GitHub account, and they can be read by anyone on the internet, including current and potential employers and colleagues. + * The Langflow repository is a public GitHub repository and, therefore, subject to the [GitHub Code of Conduct](https://docs.github.com/en/site-policy/github-terms/github-community-code-of-conduct).docs/docs/Support/troubleshooting.md (2)
17-17: Remove comma before conditional clause
Drop the comma in “..., if it is a single-use component.” to read more naturally.-Make sure the component isn't already present in your flow, if it is a single-use component. +Make sure the component isn't already present in your flow if it is a single-use component.
31-31: Use “in the account” for clarity
Replace “on the account” with “in the account” for idiomatic phrasing.-* Make sure the provided credentials are active, have the required permissions, and, if applicable, have sufficient funds on the account to execute the required action. +* Make sure the provided credentials are active, have the required permissions, and, if applicable, have sufficient funds in the account to execute the required action.docs/docs/Get-Started/get-started-installation.md (2)
39-41: Normalize admonition indentation
The:::importantblock inside the Windows tab is indented by 6 spaces, whereas other admonitions are flush-left. Align indentation for consistency or verify it renders correctly.
138-141: Remove unnecessary code fence indentation
Leading spaces before the triple backticks are not needed. Use unindented fences for clarity and consistent rendering.- ```bash - uv pip install langflow - ``` +```bash +uv pip install langflow +``` - ```bash - uv run langflow run - ``` +```bash +uv run langflow run +```Also applies to: 145-147
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
docs/docs/Contributing/contributing-community.md(1 hunks)docs/docs/Contributing/contributing-github-discussion-board.md(0 hunks)docs/docs/Contributing/contributing-github-issues.md(1 hunks)docs/docs/Develop/install-custom-dependencies.md(2 hunks)docs/docs/Get-Started/get-started-installation.md(4 hunks)docs/docs/Support/luna-for-langflow.md(1 hunks)docs/docs/Support/troubleshooting.md(1 hunks)docs/docusaurus.config.js(1 hunks)docs/sidebars.js(3 hunks)
💤 Files with no reviewable changes (1)
- docs/docs/Contributing/contributing-github-discussion-board.md
🧰 Additional context used
🪛 LanguageTool
docs/docs/Contributing/contributing-github-issues.md
[style] ~32-~32: Consider a more concise word here.
Context: ...elpful. The Langflow team needs details in order to recreate and find the issue. * **Explai...
(IN_ORDER_TO_PREMIUM)
docs/docs/Support/troubleshooting.md
[typographical] ~17-~17: Usually, there’s no comma before “if”.
Context: ...onent isn't already present in your flow, if it is a single-use component. If you s...
(IF_NO_COMMA)
[uncategorized] ~31-~31: The preposition ‘in’ seems more likely in this position.
Context: ...d, if applicable, have sufficient funds on the account to execute the required act...
(AI_HYDRA_LEO_REPLACE_ON_IN)
[style] ~69-~69: Consider using a different verb for a more formal wording.
Context: ...``` If upgrading your packages doesn't fix the issue, install gcc separately, an...
(FIX_RESOLVE)
docs/docs/Contributing/contributing-community.md
[grammar] ~35-~35: The word ‘help’ is a conjunction. In formal texts, use “to”.
Context: ...ry. For more information, see [Get help and request enhancements](/contributing-git...
(HELP_AND_VB)
🪛 markdownlint-cli2 (0.17.2)
docs/docs/Contributing/contributing-github-issues.md
37-37: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
40-40: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
41-41: Unordered list indentation
Expected: 2; Actual: 3
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (17)
docs/docusaurus.config.js (1)
280-283: LGTM! Redirect configuration is properly implemented.The redirect rule correctly maps the old GitHub discussions path to the new consolidated GitHub issues page, maintaining backward compatibility during the documentation restructuring.
docs/docs/Support/luna-for-langflow.md (4)
2-2: LGTM! Title update better reflects the enterprise nature.The title change from "Luna for Langflow" to "Enterprise support for Langflow" provides clearer context about the service offering.
6-12: LGTM! Content improvements enhance clarity and professionalism.The restructured content uses active voice and provides clearer explanations of Luna's value proposition and support scope.
13-19: LGTM! Version support information is well-structured and informative.The info block clearly specifies supported Langflow and Python versions, which is essential information for enterprise customers.
21-21: LGTM! Simplified call-to-action is more direct.The streamlined link text focuses on the key action while maintaining the essential information.
docs/docs/Contributing/contributing-community.md (3)
6-6: LGTM! Introductory sentence provides good context.The opening sentence effectively frames the various community interaction options that follow.
14-22: LGTM! New GitHub engagement sections are valuable additions.The sections on starring and watching the repository provide practical guidance for community engagement and help users understand how to stay connected with the project.
23-31: LGTM! Detailed watching instructions are helpful.The distinction between release-only notifications and full repository watching, along with the link to GitHub documentation, provides users with the information they need to customize their engagement level.
docs/sidebars.js (4)
88-88: LGTM! Telemetry placement in Configuration is more logical.Moving the telemetry document from Contributing to Configuration makes sense as it's primarily a configuration topic rather than a contribution guide.
298-298: LGTM! Label simplification improves navigation.The label change from "Contributing" to "Contribute" is more concise and action-oriented.
323-332: LGTM! Support category consolidation improves user experience.Adding the troubleshooting document and GitHub issues guidance to the Support category creates a logical grouping for users seeking help.
336-336: LGTM! Label update aligns with document title changes.The label change to "Enterprise support" matches the document title update and better describes the service offering.
docs/docs/Develop/install-custom-dependencies.md (4)
6-25: LGTM! Comprehensive optional dependency groups section.The new section clearly explains optional dependency groups with practical examples for single and multiple group installations. The reference to the pyproject.toml file is helpful for users who want to understand the available options.
26-35: LGTM! Clear guidance on custom dependency installation.The updated section provides clear instructions for installing custom dependencies, with specific guidance for working within a cloned repository using
uv add.
51-52: LGTM! Clarified instructions for cloned repository workflow.The clarification about using
uv addwhen working within a cloned repository helps users understand the appropriate workflow.
59-107: LGTM! Comprehensive project contribution guidance.The expanded section provides detailed information about the workspace structure, dependency types, and multiple methods for adding dependencies. The explanation of make commands and manual editing options gives contributors flexibility in their workflow.
docs/docs/Contributing/contributing-github-issues.md (1)
2-2: Title update is clear and actionable
The new title “Get help and request enhancements” aligns well with the consolidated content.
github-actions
Bot
added
documentation
github-actions
Bot
added
documentation
github-actions
Bot
added
documentation
|
Build successful! ✅ |
github-actions
Bot
added
documentation
|
Build successful! ✅ |
…i#8662) * change luna to enterprise support * community page updates * combine issues and discussions pages * move telemetry out of contribute * remove gerund title * rewrite issues page * fix 2 anchors * add troubleshooting page * move troubleshooting and extras from install * add some more issues * coderabbit
…i#8662) * change luna to enterprise support * community page updates * combine issues and discussions pages * move telemetry out of contribute * remove gerund title * rewrite issues page * fix 2 anchors * add troubleshooting page * move troubleshooting and extras from install * add some more issues * coderabbit
2 participants
This PR aims to build out the Troubleshoot and Support documentation by centralizing troubleshooting advice in one area.
Closes LFOSS-1486, LFOSS-1487, LFOSS-1480, LFOS-1482
Summary by CodeRabbit