https://github.com/unstructured-io/docs
Documentation for all Unstructured products and libraries
https://github.com/unstructured-io/docs
Last synced: about 1 year ago
JSON representation
Documentation for all Unstructured products and libraries
- Host: GitHub
- URL: https://github.com/unstructured-io/docs
- Owner: Unstructured-IO
- Created: 2024-04-12T11:44:37.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-20T19:20:52.000Z (over 1 year ago)
- Last Synced: 2025-03-20T20:16:31.506Z (over 1 year ago)
- Language: MDX
- Size: 24 MB
- Stars: 7
- Watchers: 20
- Forks: 22
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Documentation for Unstructured products
This repo hosts documentation for:
* [Unstructured Open Source Library](https://github.com/Unstructured-IO/unstructured)
* [Unstructured APIs](https://unstructured.io/api-key-hosted)
* [Unstructured Enterprise platform](https://unstructured.io/platform)
## Contributing to the documentation
Everyone is welcome to contribute, and you can do it in a couple of ways:
* See something wrong with the existing documentation? Need a new example/tutorial? Submit a [GitHub Issue](https://github.com/huggingface/cookbook/issues).
* Improve the docs by opening a pull request.
### Creating a pull request
To contribute changes to the documentation:
1. If you're not a member of Unstructured team, start by forking the repo. If you are part of the team, you can clone this repo.
2. Create a new branch with a descriptive name.
3. Add your changes. DO NOT MANUALLY EDIT THE CONTENTS OF THE `snippets/destination_connectors` and `snippets/source_connectors` FOLDERS. These are auto-generated from tested code examples.
4. Check for grammatical and technical correctness of the changes.
5. Preview your changes locally. [See how below](#previewing-documentation-changes-locally).
6. Create a pull request.
7. Ping [MKhalusova](https://github.com/mkhalusova) for a review.
### Previewing documentation changes locally
Before creating a pull request, make sure your changes are built and displayed correctly locally.
1. Install node.js: `brew install node`
2. Install mintlify: `npm i -g mintlify`
3. Navigate to the docs directory (where the `mint.json` file is located) and run: `mintlify dev`. Local preview should be available at `http://localhost:3000`.