docs: updates to make commands#9529
Conversation
|
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 WalkthroughDocumentation updates restructure development workflow guidance: decouple init from build/run, add a quick-start make target, clarify command differences, and add dev container notes for docs. Edits are limited to DEVELOPMENT.md and a contributing guide MDX file. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
✨ 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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
github-actions
Bot
added
the
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
![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
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
docs/docs/Contributing/contributing-how-to-contribute.mdx (1)
1-4: Add required frontmatter description fieldPer docs guidelines, every page needs at least title and description in frontmatter. This file is missing description. Add a concise sentence that reflects the page’s purpose for SEO and previews.
Apply this diff:
--- title: Contribute to Langflow +description: Learn how to contribute to Langflow, set up the development environment, run from source, and build the documentation. slug: /contributing-how-to-contribute ---
🧹 Nitpick comments (2)
DEVELOPMENT.md (2)
60-66: Grammar: “set up” (verb), not “setup”Minor wording fix for clarity and correctness.
Apply this diff:
-To setup and validate the initial environment, run: +To set up and validate the initial environment, run:
170-171: Fix markdownlint MD034: wrap bare URLWrap the URL to satisfy markdownlint and render consistently.
Apply this diff:
-Navigate to http://localhost:3001/ in a browser and view the documentation. Documentation updates will be visible as they are saved, though sometimes the browser page will also need to be refreshed. +Navigate to <http://localhost:3001/> in a browser and view the documentation. Documentation updates will be visible as they are saved, though sometimes the browser page will also need to be refreshed.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
DEVELOPMENT.md(4 hunks)docs/docs/Contributing/contributing-how-to-contribute.mdx(2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
docs/docs/**/*.{md,mdx}
📄 CodeRabbit inference engine (.cursor/rules/docs_development.mdc)
docs/docs/**/*.{md,mdx}: All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
All documentation Markdown and MDX files must begin with a frontmatter block including at least title and description fields.
Use admonitions (:::tip, :::warning, :::danger) in Markdown/MDX files to highlight important information, warnings, or critical issues.
All images referenced in documentation must include descriptive alt text for accessibility.
All code examples included in documentation must be tested and verified to work as shown.
Internal links in documentation must be functional and not broken.
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, Flow, and uppercase API and JSON.
Files:
docs/docs/Contributing/contributing-how-to-contribute.mdx
🧠 Learnings (6)
📚 Learning: 2025-06-23T12:46:29.953Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-06-23T12:46:29.953Z
Learning: The documentation site is built and served locally using 'yarn build' and 'yarn serve', and is automatically deployed on commit to the main branch.
Applied to files:
DEVELOPMENT.mddocs/docs/Contributing/contributing-how-to-contribute.mdx
📚 Learning: 2025-07-18T18:26:42.027Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: All documentation changes must be built and served locally using yarn build and yarn serve before deployment.
Applied to files:
DEVELOPMENT.mddocs/docs/Contributing/contributing-how-to-contribute.mdx
📚 Learning: 2025-06-23T12:46:29.953Z
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.
Applied to files:
DEVELOPMENT.md
📚 Learning: 2025-07-18T18:26:42.027Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Documentation is automatically deployed on commit to the main branch; build artifacts are output to the build/ directory and served via CDN.
Applied to files:
DEVELOPMENT.mddocs/docs/Contributing/contributing-how-to-contribute.mdx
📚 Learning: 2025-07-18T18:26:42.027Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : 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.
Applied to files:
docs/docs/Contributing/contributing-how-to-contribute.mdx
📚 Learning: 2025-07-18T18:26:42.027Z
Learnt from: CR
PR: langflow-ai/langflow#0
File: .cursor/rules/docs_development.mdc:0-0
Timestamp: 2025-07-18T18:26:42.027Z
Learning: Applies to docs/docs/**/*.{md,mdx} : All documentation content must be written in Markdown or MDX files located under docs/docs/, following the prescribed directory structure for guides, reference, how-to, concepts, and API documentation.
Applied to files:
docs/docs/Contributing/contributing-how-to-contribute.mdx
🪛 markdownlint-cli2 (0.17.2)
DEVELOPMENT.md
170-170: Bare URL used
(MD034, no-bare-urls)
🪛 LanguageTool
docs/docs/Contributing/contributing-how-to-contribute.mdx
[grammar] ~122-~122: There might be a mistake here.
Context: ...nment but doesn't start the application. make run_cli installs dependencies, bu...
(QB_NEW_EN)
⏰ 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). (1)
- GitHub Check: build-and-deploy
🔇 Additional comments (3)
docs/docs/Contributing/contributing-how-to-contribute.mdx (2)
121-126: Change admonition to tip and tighten wordingWe’ve confirmed that the Makefile (including
Makefile.frontend) defines theinit,run_cli,backend, andfrontendtargets. Please update lines 121–126 indocs/docs/Contributing/contributing-how-to-contribute.mdxas follows:-:::important Difference between commands -`make init` sets up the development environment but doesn't start the application. -`make run_cli` installs dependencies, builds the frontend, and starts the application in one step. -For development with hot-reload, use `make init`, followed by `make backend` and `make frontend` commands in separate terminals. -::: +:::tip Difference between commands +`make init` sets up the development environment; it does not start the application. +`make run_cli` installs dependencies, builds the frontend, and starts the application in one step. +For development with hot reload, run `make init`, then `make backend` and `make frontend` in separate terminals. +:::
210-214: Change admonition to warning and verify docs build locallyPlease update the note in docs/docs/Contributing/contributing-how-to-contribute.mdx (lines 210–214) to use a warning admonition and streamline the text:
- File: docs/docs/Contributing/contributing-how-to-contribute.mdx - Lines: 210–214 -:::important -If you're using a dev container, run the documentation build from outside the container on your host terminal, not from within the dev container workspace. -The documentation build may not work properly when run inside the dev container. -::: +:::warning +If you’re using a dev container, build the docs from your host terminal (outside the container). Builds may not work properly inside the container. +:::I attempted to run the original verification script in the sandbox environment, but encountered Node/Yarn post-install errors that prevented a successful build. Please verify on your local setup (with a proper Node.js runtime):
cd docs # (Optional) clean previous node_modules & cache rm -rf node_modules .cache yarn install yarn build yarn serve --port 3001 --host 127.0.0.1Ensure the site builds without errors and that all links resolve correctly.
DEVELOPMENT.md (1)
68-75: Nice addition: quick-start via make run_cliClear callout that run_cli installs, builds, and starts in one step. This improves onboarding. LGTM.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
aimurphy
left a comment
aimurphy
left a comment
There was a problem hiding this comment.
Some things are confusing
github-actions
Bot
added
documentation
Co-authored-by: April I. Murphy <36110273+aimurphy@users.noreply.github.com>
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
This comment has been minimized.
This comment has been minimized.
github-actions
Bot
added
documentation
|
|
Build successful! ✅ |
2 participants
make initandmake run_clito start Langflow.Summary by CodeRabbit