From b054e49395cf73e294e7f13c7812aa84d9513028 Mon Sep 17 00:00:00 2001 From: Paul-Cornell Date: Tue, 3 Feb 2026 12:33:30 -0800 Subject: [PATCH] Update README.md --- README.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index fff713ef..1eb57cae 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,36 @@ -# Documentation for Unstructured products +# Unstructured technical documentation -This repo hosts documentation for: +This repository hosts the public documentation source content 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) - -👉 Looking for the live documentation site powered by this repo? Visit [docs.unstructured.io](https://docs.unstructured.io/) +* [The Unstructured user interface](https://docs.unstructured.io/ui/overview) +* [The Unstructured API](https://docs.unstructured.io/api-reference/overview) +* [Unstructured for Business](https://docs.unstructured.io/business/overview) +* [The Unstructured open source library](https://docs.unstructured.io/open-source/introduction/overview) ## 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. +* See something wrong with the existing documentation? Need a new example/tutorial? [Submit an issue](https://github.com/Unstructured-IO/docs/issues). +* Improve the docs by creating a pull request (see the next section). ### Creating a pull request -To contribute changes to the documentation: +To contribute changes to the documentation by creating a pull request: -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. +1. If you're not a member of the internal Unstructured documentation team, start by [forking this repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo). If you are part of the internal Unstructured documentation team, you can [clone this repo](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) instead. 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. +3. Add your changes. 4. Check for grammatical and technical correctness of the changes. -5. Preview your changes locally. [See how below](#previewing-documentation-changes-locally). +5. Ideally, you should preview your changes locally (see the next section). 6. Create a pull request. -7. Ping [MKhalusova](https://github.com/mkhalusova) for a review. +7. Add [Paul-Cornell](https://github.com/Paul-Cornell) and [ajaykrish-uns](https://github.com/ajaykrish-uns) to your pull request's list of reviewers. They will be automatically notified to review it. One of them will review your pull request. Once the pull request is final and approved, they will merge and publish your contribution! ### Previewing documentation changes locally -Before creating a pull request, make sure your changes are built and displayed correctly locally. +Before creating a pull request, you should check to 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`. +3. Navigate to the `docs` directory (where the `mint.json` file is located) and run: `mint dev`. Local preview should be available at `http://localhost:3000`.