Docs: Components cleanup #5987
Merged
Docs: Components cleanup #5987
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add detailed documentation for: - AstraDB Graph vector store - Elasticsearch vector store Update existing documentation links and improve component descriptions
…"Run flow" component
dosubot
bot
added
size:XL
mendonk
commented
Jan 29, 2025
mendonk
commented
Jan 29, 2025
mendonk
commented
Jan 29, 2025
KimberlyFields
approved these changes
Jan 31, 2025
There was a problem hiding this comment.
@mendonk I'm approving this PR so the new content can be published. However, you need to create a Jira ticket to go through all of the component content and audit it for style consistency and clarify. I see a lot of inconsistencies in punctuation, capitalization, and usage of articles. Also, there's a lot of "duh" doc in here, meaning that the description of an input or output repeats the name of the input/output with not additional explanation. Where you can, you need to add context around the input and output items.
Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
edwinjosechittilappilly
pushed a commit
that referenced
this pull request
Jan 31, 2025
* docs: Expand vector stores documentation with new components Add detailed documentation for: - AstraDB Graph vector store - Elasticsearch vector store Update existing documentation links and improve component descriptions * filesize-note * docs: Update memory chatbot tutorial and add new components documentation * docs: new-api-request-inputs * docs: Update documentation to replace deprecated "Flow as Tool" with "Run flow" component * docs: Add Tavily AI Search and Wikidata components documentation * renamed-conditional-router * move-url-component * docs:url-fix * Apply suggestions from code review * docs: cloudflare links * docs: improve link formatting * docs: add output details * docs: add SQL Query and Batch Run component * fix-bottom-table * avoid-future-tense * code-review * Apply suggestions from code review Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com> * fix-linking-errors --------- Co-authored-by: KimberlyFields <46325568+KimberlyFields@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes several updates and additions to documentation across various components. The most significant changes involve renaming components, deprecating older components, and adding new components with detailed descriptions and usage instructions.
Documentation Updates:
docs/docs/Agents/agent-tool-calling-agent-component.md: Updated the documentation to replace references to the "Flow as Tool" component with the "Run Flow" component.docs/docs/Components/components-data.md:Component Deprecations:
docs/docs/Components/components-embedding-models.md: Deprecated the Astra DB vectorize component and provided instructions to use the new Astra DB vector store component.docs/docs/Components/components-logic.md: Deprecated the Flow as Tool and Sub Flow components, recommending the use of the Run Flow component instead. [1] [2]New Component Additions:
docs/docs/Components/components-embedding-models.md: Added new components for generating embeddings using Cloudflare Workers AI, LM Studio, and updated existing components with additional inputs and outputs. [1] [2]docs/docs/Components/components-memories.md: Introduced Mem0 Chat Memory and Redis Chat Memory components for storing and retrieving chat messages.docs/docs/Components/components-processing.md: Added several new processing components, including Alter Metadata, LLM Router, Merge Data, and others to enhance data manipulation capabilities.