-
Notifications
You must be signed in to change notification settings - Fork 8.4k
Docs: 1.8 release #11295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Docs: 1.8 release #11295
Conversation
add-jq-and-path-to-data-operations
* 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]>
* 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
* 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]>
* 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]>
* 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]>
* 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]>
* 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>
* add-comet-bundle-back-for-1.7 * add-comet-to-release-notes
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
* add-global-var-in-mcp-headers * revert-curl-syntax-change * remove-duplicate-tab * Apply suggestions from code review Co-authored-by: April I. Murphy <[email protected]> * remove-code-block * add-release-note --------- Co-authored-by: April I. Murphy <[email protected]>
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 15
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (9)
docs/docs/Develop/install-custom-dependencies.mdx (2)
1-4: Add required frontmatter fields (description,sidebar_position).The YAML frontmatter is missing the required
descriptionandsidebar_positionfields.✅ Suggested update
--- title: Install custom dependencies +description: Add custom dependencies and optional groups for Langflow packages +sidebar_position: 30 slug: /install-custom-dependencies ---As per coding guidelines, docs/docs/**/*.{md,mdx} files must include title, description, and sidebar_position in frontmatter.
47-55: Add titles to the new code fences.Several new code blocks omit the required
titleattribute.🧩 Example pattern to apply
-```bash -uv pip install "langflow[postgresql]" -``` +```bash title="Install langflow with the postgresql extra" +uv pip install "langflow[postgresql]" +```As per coding guidelines, code blocks in docs must include a title attribute and specify the language.
Also applies to: 69-77, 81-83, 91-98, 102-105, 129-131
docs/docs/Components/url.mdx (1)
21-28: Use the required table columns for parameters.
The parameters table doesn’t include the required columns (Input/Output name, Type, Required, Description). Please update the header and rows accordingly. As per coding guidelines, ...♻️ Suggested table header update
-| Name | Display Name | Info | -|------|--------------|------| +| Input name | Type | Required | Description | +|------------|------|----------|-------------|docs/docs/Components/components-prompts.mdx (3)
1-4: Add required frontmatter fields (description, sidebar_position).Docs standards require
title,description, andsidebar_positionin frontmatter. Please add the missing fields.
35-64: Fix ordered list numbering (missing step 3).The sequence jumps from step 2 to step 4, which reads as an editing error.
48-56: Add code block titles per docs standards.Code blocks must include a
titleattribute. Suggested update:📝 Example fix
- ```text + ```text title="prompt-template.txt" @@ - ```text + ```text title="mustache-template.txt"Also applies to: 95-100
docs/docs/Components/smart-transform.mdx (1)
1-4: Add required frontmatter fields (description, sidebar_position).Docs standards require
title,description, andsidebar_positionin frontmatter. Please add the missing fields.docs/docs/Agents/mcp-client.mdx (2)
1-4: Add required frontmatter fields (description, sidebar_position).Docs standards require
title,description, andsidebar_positionin frontmatter. Please add the missing fields.
97-103: Align the parameters table with the required column schema.Tables must include Input/Output name, Type, Required, and Description columns. Please reformat this table to match.
🤖 Fix all issues with AI agents
In `@docs/docs/Agents/mcp-client.mdx`:
- Around line 132-165: Add a title attribute to each fenced code block in the
docs example sections so they include identifiable filenames (e.g., change
```python to ```python title="mcp-tweaks.py", ```typescript to ```typescript
title="mcp-tweaks.ts" and ```bash to ```bash title="mcp-tweaks.sh"); update the
three code blocks that contain LANGFLOW_SERVER_ADDRESS/payload examples and the
other example blocks referenced (around the blocks that use variables like
FLOW_ID, MCP_TOOLS_COMPONENT_ID and the TypeScript and bash equivalents) so
every fenced block has a title attribute consistent with the suggested
filenames.
In `@docs/docs/Components/components-prompts.mdx`:
- Around line 22-25: The parameters table for the prompt component is missing
the required column schema; replace the current columns (Name/Display
Name/Description) with the standard columns "Input/Output name", "Type",
"Required", and "Description", and update the rows for the parameters `template`
and `use_double_brackets` accordingly: set `template` as type "string", mark it
"Required" (yes) and keep the description about f-string `{VARIABLE_NAME}` and
the `<PartialCurlyBraces />` note; set `use_double_brackets` as type "boolean",
mark it "Required" (no) and keep the description about Mustache `{{variable}}`
with the link to "Use Mustache templating in prompt templates". Ensure
formatting follows the existing MDX table syntax.
In `@docs/docs/Components/smart-transform.mdx`:
- Around line 38-44: Update the parameters table header from "Name | Display
Name | Info" to the required schema "Input/Output name | Type | Required |
Description" and replace the "Info" column with "Description"; then update each
row for the parameters `data`, `model`, `filter_instruction`, `sample_size`, and
`max_size` to fill the new columns: set Type to the referenced types
(`Data`/`DataFrame`/`Message` for `data`, `LanguageModel` for `model`,
`string`/instructions for `filter_instruction`, `number` for `sample_size` and
`max_size`), mark `data` and `filter_instruction` as Required: Yes, `model` as
Required: No (optional), and `sample_size`/`max_size` as Required: No with their
default values noted in the Description column (e.g., `sample_size` default
1000, `max_size` default 30000); keep the existing descriptive text for each
parameter in the Description column.
In `@docs/docs/Components/url.mdx`:
- Around line 39-41: Update the output format list item that currently reads "*
**Markdown**: The component converts the HTML content to markdown format using
[Markitdown](https://github.com/microsoft/markitdown)." to capitalize "Markdown"
in the description (i.e., change "markdown format" to "Markdown format") so the
term is consistently capitalized; locate the list under the output formats
section in the URL component docs (the three bullets including **Text
(default)**, **Markdown**, **HTML**) and make this single-word capitalization
change.
In `@docs/docs/Develop/install-custom-dependencies.mdx`:
- Around line 8-10: Update the phrase "root level `pyproject.toml`" to use the
correct compound adjective "root-level `pyproject.toml`" in the sentence
describing the main package ("The `main` package (`langflow`) is managed by the
root level `pyproject.toml`, and it includes...") so the docs read "managed by
the root-level `pyproject.toml`".
- Around line 65-66: Fix the duplicated phrase in the sentence that starts
"These optional dependency groups are listed in the in the [langflow-base
`pyproject.toml`]" by removing the extra "in the" so it reads "These optional
dependency groups are listed in the [langflow-base `pyproject.toml`] file under
`[project.optional-dependencies]`." Locate and update that exact sentence in the
docs page to remove the duplicated wording.
In `@docs/docs/Develop/jwt-authentication.mdx`:
- Around line 1-4: The frontmatter for the JWT authentication doc is missing
required fields; update the top YAML block (the existing title and slug) to
include a descriptive "description" and an integer "sidebar_position" so the
page meets docs frontmatter requirements; add a concise human-readable
description string and an appropriate numeric sidebar_position value to the
frontmatter near the existing title and slug entries.
- Around line 68-82: The two bash code blocks generating HS256 secret keys are
missing title attributes; update the Python code block (the one containing
python -c "import secrets; print(secrets.token_urlsafe(32))") to use a fenced
code block with title="Generate secret key with Python" and update the OpenSSL
block (the one containing openssl rand -base64 32) to use title="Generate secret
key with OpenSSL"; also ensure the subsequent example showing LANGFLOW_ALGORITHM
and LANGFLOW_SECRET_KEY remains unchanged but visually aligned with the titled
examples.
- Around line 40-47: Update the environment-variable table so it has the
required columns: "Input/Output name", "Type", "Required", and "Description";
for each variable listed (LANGFLOW_ALGORITHM, LANGFLOW_SECRET_KEY,
LANGFLOW_PRIVATE_KEY, LANGFLOW_PUBLIC_KEY, LANGFLOW_ACCESS_TOKEN_EXPIRE_SECONDS,
LANGFLOW_REFRESH_TOKEN_EXPIRE_SECONDS) add a Type (e.g., string or integer),
mark whether it is Required (yes/no or auto-generated), and move the current
Default information into the Description column or include it as part of the
Description so the table conforms to the documentation guidelines.
- Around line 198-212: The docs mix two environment variable names
(JWT_SECRET_KEY and LANGFLOW_SECRET_KEY); update the examples so they use a
single consistent name or explicitly document the mapping: either change the
.env example to LANGFLOW_SECRET_KEY to match the Docker Compose example
(references to LANGFLOW_SECRET_KEY in the compose YAML and any code that reads
LANGFLOW_SECRET_KEY), or add a brief sentence stating that JWT_SECRET_KEY is a
local .env alias that should be exported as LANGFLOW_SECRET_KEY for the
container; ensure the unique symbols JWT_SECRET_KEY and LANGFLOW_SECRET_KEY are
consistently referred to in the JWT setup section and examples.
- Around line 16-18: Locate the malformed HTML tag <details closedn> in the JWT
docs (the tag name is "details" and the incorrect attribute is "closedn") and
fix the attribute to the proper "closed" (i.e., change closedn → closed) so the
renderer recognizes the collapsed details section; ensure there are no other
instances of "closedn" left in the file.
- Around line 23-25: Replace the hard-coded JWT example string found in
jwt-authentication.mdx with a clear non-secret placeholder (e.g.,
<YOUR_JWT_HERE> or {JWT_TOKEN}) so static scanners won’t flag it; locate the
literal token string (the long base64-looking value) in the example block and
substitute it with the placeholder text and an explanatory note that it is only
an example and must be replaced in real usage.
- Around line 100-117: Replace the inline PEM examples in the
jwt-authentication.mdx docs (the LANGFLOW_ALGORITHM, LANGFLOW_PRIVATE_KEY and
LANGFLOW_PUBLIC_KEY examples) with non-secret placeholders or sanitized
multi-line placeholders (e.g., "<PRIVATE_KEY_PLACEHOLDER>" and
"<PUBLIC_KEY_PLACEHOLDER>") so secret scanners won’t flag the file; update the
two bash example blocks to show the same placeholder values and add a brief note
that real PEMs should be pasted without headers in .env or sourced from a secure
vault.
- Around line 223-306: Update the YAML code fences in
docs/docs/Develop/jwt-authentication.mdx to include title attributes so each
snippet shows its filename: change the first docker-compose snippet fence to
include title="docker-compose.yml", change the second docker-compose snippet
fence to include the same title for the mounted-keys example, and add
title="jwt-secret.yaml" to the JWT secret block and
title="langflow-deployment.yaml" to the deployment block; locate the fences by
spotting the YAML blocks around the docker-compose examples and the
jwt-secret/langflow-deployment snippets and add the title="..." attribute to
each opening ```yaml fence accordingly.
In `@docs/docs/Support/release-notes.mdx`:
- Around line 50-93: Add title attributes to the two bash code blocks that show
pip install commands: the block containing uv pip install
"langflow-base[complete]" should be changed to include a title (e.g.,
title="Install langflow-base (complete)") and the block containing uv pip
install "langflow-base[postgresql,openai,chroma]" should be changed to include a
title (e.g., title="Install langflow-base with extras"); locate the blocks by
searching for the exact strings uv pip install "langflow-base[complete]" and uv
pip install "langflow-base[postgresql,openai,chroma]" in the release-notes.mdx
content and add the title attributes to the triple-backtick opening fences.
🧹 Nitpick comments (2)
docs/docs/Develop/jwt-authentication.mdx (1)
9-13: Reminder: run docs build/serve to validate this new page.
Please runyarn buildandyarn serveto catch broken links and rendering issues. Based on learnings, ...docs/docs/Agents/mcp-client.mdx (1)
113-274: Run docs build/serve to validate new links and rendering.Given the number of new sections and internal links, please run
yarn buildandyarn serveto catch broken links or rendering issues. Based on learnings, ...
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
1 similar comment
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
Build successful! ✅ |
This branch accepts docs PRs for Langflow v1.8 features, and will merge at release.
Features
Additional Docs
V2 API /workflow endpoints and spec build (#11323)
Global model provider(#11231)
Operations component(#11395)
Chat refactor
Component inspector
Agent Blocks