- Getting Started
- Quickstart
Getting Started
Quickstart
Build beautiful documentation that converts users
See how other companies are building high-converting documentation on our showcase.
Getting Started
The quickstart assumes that you set up the Starter Project and completed the Get Started form.
Install the GitHub Bot
After completing the onboarding form, you should have received an email with the get started instructions. Install the Mintlify GitHub Bot using the link provided, making sure it’s granted access to the repo with the documentation.
Now, when you make changes to the docs and push them to the main branch, it will automatically update your documentation page! It’s that simple
Learn More
Common Guides
Select from the following guides to learn more about how Mintlify can best suit your documentation.
Development
Run Mintlify on your computer to see changes locally
Global Settings
Customizing the theme, branding, and other global configurations
Page Titles and Metadata
Setting the title and metadata for navigation and SEO
Writing Content
Introduction on how to add and edit content
Advanced Topics
Dive deeper into advanced guides to take your documentation to the next level.