Skip to content

docs: link components to docs pages#8589

Closed
mendonk wants to merge 95 commits into
mainfrom
docs-link-components-to-docs-pages
Closed

docs: link components to docs pages#8589
mendonk wants to merge 95 commits into
mainfrom
docs-link-components-to-docs-pages

Conversation

@mendonk
Copy link
Copy Markdown
Collaborator

@mendonk mendonk commented Jun 17, 2025

Merge this into #8387 to add links to the component documentation from the playground.
Breaking it out into its own PR because it touches component code.

Summary by CodeRabbit

  • Documentation

    • Expanded and reorganized component documentation, adding detailed usage examples, new sections for data and integration components, and clarifying legacy status for certain logic components.
    • Improved clarity and accuracy in template and concept guides, including step-by-step instructions, inline icons, and updated terminology.
    • Added a comprehensive release notes document summarizing major updates across recent versions.
    • Updated sidebar navigation to include the new release notes entry.
  • Starter Projects

    • Added direct documentation links to component definitions in all starter projects, enhancing discoverability and user guidance.
    • Updated default values and input options in select starter projects for consistency and clarity.
  • User Interface

    • Enhanced documentation and UI references by incorporating visual icons in instructions for running components and flows.
  • Chores

    • Standardized metadata and formatting in starter project configurations for improved consistency.

@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 27, 2025
@github-actions

This comment was marked as outdated.

@mendonk mendonk force-pushed the docs-link-components-to-docs-pages branch from a96f184 to acc2748 Compare June 27, 2025 14:39
@dosubot dosubot Bot added size:XXL This PR changes 1000+ lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Jun 27, 2025
@github-actions github-actions Bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Jun 27, 2025
@github-actions
Copy link
Copy Markdown
Contributor

Build failure! ❌

yarn run v1.22.22 $ docusaurus build [INFO] [en] Creating an optimized production build... [info] [webpackbar] Compiling Client [info] [webpackbar] Compiling Server [success] [webpackbar] Server: Compiled with some errors in 59.73s [success] [webpackbar] Client: Compiled with some errors in 1.51m [ERROR] Client bundle compiled with errors therefore further build is impossible. Error: MDX compilation failed for file "/home/runner/work/langflow/langflow/docs/docs/Components/components-data.md" Cause: Image static/img/component-api-request-chat-output.png used in docs/Components/components-data.md not found. Details: Error: Image static/img/component-api-request-chat-output.png used in docs/Components/components-data.md not found. at async Promise.all (index 1) -------------------------- Error: MDX compilation failed for file "/home/runner/work/langflow/langflow/docs/docs/Components/components-logic.md" Cause: Image static/img/loop-text-summarizer.png used in docs/Components/components-logic.md not found. Details: Error: Image static/img/loop-text-summarizer.png used in docs/Components/components-logic.md not found. at async Promise.all (index 0) -------------------------- Error: MDX compilation failed for file "/home/runner/work/langflow/langflow/docs/docs/Components/components-processing.md" Cause: Image static/img/component-url-regex.png used in docs/Components/components-processing.md not found. Details: Error: Image static/img/component-url-regex.png used in docs/Components/components-processing.md not found. at async Promise.all (index 12) error Command failed with exit code 1. info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.

@mendonk
Copy link
Copy Markdown
Collaborator Author

mendonk commented Jun 27, 2025

Superseded by #8766

@mendonk mendonk closed this Jun 27, 2025
@mendonk mendonk deleted the docs-link-components-to-docs-pages branch October 29, 2025 21:24
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 fast-track Skip tests and sends PR into the merge queue lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants