Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs: components updates #5315

Merged
merged 40 commits into from
Dec 20, 2024
Merged

Docs: components updates #5315

merged 40 commits into from
Dec 20, 2024

Conversation

mendonk
Copy link
Collaborator

@mendonk mendonk commented Dec 17, 2024 •
edited
Loading

Add a "generic" component usage section at the top of each component page, with additional pointers or gotchas to help users use the component of their choice.

Some additional fixes:

  1. Move custom components page out of helpers.
  2. Remove and redirect RAG component page, out of date.
  3. Move components to below workspace.
  4. Processing page up to date.
  5. Tip for loaders page which are now in Bundles in the UI.

mendonk added 28 commits December 12, 2024 12:52
@mendonk
docs: enhance agent components documentation for clarity and detail
5b75030
@mendonk
docs: expand tools documentation to clarify agent-tool interactions a…
24bbbee 
…nd usage
@mendonk
docs: clarify installation instructions in README
68f80e1
@mendonk
Merge branch 'main' into docs-components-updates
e8e55dd
@mendonk
Merge branch 'main' into docs-components-updates
e7c221c
@mendonk
tools
e24d4cd
@mendonk
custom-components
4df12eb
@mendonk
docs: update Tool Mode documentation to include additional input type…
4a9799c 
…s and usage examples
@mendonk
docs: enhance components-data documentation with usage examples and p…
60e5a11 
…rocessing details
@mendonk
docs: refine components-data and components-embedding-models document…
ae65c15 
…ation for clarity and detail
@mendonk
docs: update components-memories documentation for inputs and outputs…
1cdd4ee 
…; add new components-processing documentation
@mendonk
stepping-away
9dd8f4d
@mendonk
helpers
27b696b
@mendonk
components-io
d6ae8b0
@mendonk
loaders
f565495
@mendonk
docs: update components and guides for clarity and consistency; refin…
2e27538 
…e memory component descriptions
@mendonk
models
fb2bde1
@mendonk
docs: restructure components-prompts documentation for clarity and co…
9c5921d 
…nsistency
@mendonk
Merge branch 'main' into docs-components-updates
abf84fe
@mendonk
prompts
c21b38d
@mendonk
docs: update components-prompts documentation for clarity and improve…
4202906 
…d examples
@mendonk
docs: add redirect from components-rag to components-vector-stores an…
cb108ee 
…d remove components-rag documentation
@mendonk
sidebar-remove-vectara-rag
3c4d455
@mendonk
move-components-tab-after-workspace
63454d5
@mendonk
vector-store
1b2fa4b
@mendonk
link
1977294
@mendonk
processing
6724976
@mendonk
Merge branch 'main' into docs-components-updates
bce0f86
@mendonk mendonk self-assigned this Dec 17, 2024
@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. documentation Improvements or additions to documentation labels Dec 17, 2024
@mendonk mendonk changed the title Docs components updates Docs: components updates Dec 17, 2024
KimberlyFields
KimberlyFields reviewed Dec 18, 2024
View reviewed changes
@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 Dec 19, 2024
@carlosrcoelho carlosrcoelho self-requested a review December 20, 2024 20:48
KimberlyFields
KimberlyFields approved these changes Dec 20, 2024
View reviewed changes
Copy link
Collaborator

@KimberlyFields KimberlyFields left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a few comments and suggestions, but I'm approving.

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Dec 20, 2024
@mendonk mendonk enabled auto-merge December 20, 2024 21:37
@mendonk mendonk added this pull request to the merge queue Dec 20, 2024
Merged via the queue into main with commit a269023 Dec 20, 2024
10 checks passed
@mendonk mendonk deleted the docs-components-updates branch December 20, 2024 21:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@KimberlyFields KimberlyFields KimberlyFields approved these changes

@carlosrcoelho carlosrcoelho Awaiting requested review from carlosrcoelho

Assignees

@mendonk mendonk

Labels
documentation Improvements or additions to documentation lgtm This PR has been approved by a maintainer size:XXL This PR changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mendonk @KimberlyFields