simplesagar/docs-2

Documentation for all Unstructured products and libraries

Documentation for Unstructured products

This repo hosts documentation for:

• Unstructured Open Source Library
• Unstructured APIs
• Unstructured Enterprise 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.
• Improve the docs by opening a pull request.

Creating a pull request

To contribute changes to the documentation:

1. Fork the 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.
6. Create a pull request.
7. Ping 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.