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.

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

docs: improve docs for UnstructuredFileConverter #908

Closed
anakin87 opened this issue Jul 17, 2024 · 4 comments
Closed

docs: improve docs for UnstructuredFileConverter #908

anakin87 opened this issue Jul 17, 2024 · 4 comments
Assignees
Labels
type:documentation Improvements or additions to documentation

Comments

@anakin87
Copy link
Member

While UnstructuredFileConverter is powerful and quite used by the community,
our current docs and integration page are minimal.

I would like to expand the current docs

  • specify/explain all the supported APIs: hosted - free and paid; local - via Docker (see also Unstructured: better support for hosted APIs #169)
  • better show that the converter supports passing a directory and automatically converting files within it
  • better show some of the supported file types
@anakin87 anakin87 added the type:documentation Improvements or additions to documentation label Jul 17, 2024
@dfokina
Copy link
Contributor

dfokina commented Jul 31, 2024

@anakin87 When you have a chance to get to this issue, I have created a Notion page with some notes.

@anakin87
Copy link
Member Author

@dfokina thanks!
Done.

When the docs are updated, I can take care of updating the integration page similarly...

@dfokina
Copy link
Contributor

dfokina commented Aug 1, 2024

Updated the docs: https://docs.haystack.deepset.ai/docs/unstructuredfileconverter

@anakin87
Copy link
Member Author

anakin87 commented Aug 2, 2024

@anakin87 anakin87 closed this as completed Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants