> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stinwo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Start building awesome documentation in under 5 minutes

## Setup your development

Learn how to update your docs locally and deploy them to the public.

### Edit and preview

> **Clone your docs locally**
>
> During the onboarding process, we created a repository on your Github with
> your docs content. You can find this repository on our
> [dashboard](https://dashboard.mintlify.com). To clone the repository
> locally, follow these
> [instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)
> in your terminal.

> **Preview changes**
>
> Previewing helps you make sure your changes look as intended. We built a
> command line interface to render these changes locally.
>
> 1. Install the
>    [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the
>    documentation changes locally with this command: `npm i -g mintlify`
>
> 2. Run the following command at the root of your documentation (where
>    `docs.json` is): `mintlify dev`
>
> > [!NOTE]
> >
> > If you’re currently using the legacy `mint.json` configuration file, please update the Mintlify CLI:
> >
> > `npm i -g mintlify@latest`
> > And run the new upgrade command in your docs repository:
> >
> > `mintlify upgrade`
> > You should now be using the new `docs.json` configuration file. Feel free to delete the `mint.json` file from your repository.

### Deploy your changes

> **Install our Github app**
>
> Our Github app automatically deploys your changes to your docs site, so you
> don't need to manage deployments yourself. You can find the link to install on
> your [dashboard](https://dashboard.mintlify.com). Once the bot has been
> successfully installed, there should be a check mark next to the commit hash
> of the repo.

> **Push your changes**
>
> [Commit and push your changes to
> Git](https://docs.github.com/en/get-started/using-git/pushing-commits-to-a-remote-repository#about-git-push)
> for your changes to update in your docs site. If you push and don't see that
> the Github app successfully deployed your changes, you can also manually
> update your docs through our [dashboard](https://dashboard.mintlify.com).

## Update your docs

Add content directly in your files with MDX syntax and React components. You can use any of our components, or even build your own.

> **[Add Content With MDX](https://docs.stinwo.com/essentials/markdown.md)**
>
> Add content to your docs with MDX syntax.

> **[Add Code Blocks](https://docs.stinwo.com/essentials/code.md)**
>
> Add code directly to your docs with syntax highlighting.

> **[Add Images](https://docs.stinwo.com/essentials/images.md)**
>
> Add images to your docs to make them more engaging.

> **[Add Custom Components](https://docs.stinwo.com/essentials/reusable-snippets.md)**
>
> Add templates to your docs to make them more reusable.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.