diff --git a/docs.json b/docs.json index f2bfd0a51..ea65b9f58 100644 --- a/docs.json +++ b/docs.json @@ -27,6 +27,7 @@ "pages": [ "index", "quickstart", + "instant-previews", "ai-native", "migration" ] diff --git a/instant-previews.mdx b/instant-previews.mdx new file mode 100644 index 000000000..d5e41225c --- /dev/null +++ b/instant-previews.mdx @@ -0,0 +1,61 @@ +--- +title: "Instant previews" +description: "Generate a hosted preview of any public GitHub repository by replacing the domain in the URL" +--- + +Instant previews let you generate a fully-hosted site for any public GitHub repository by replacing `github.com` with `mintlify.com` in the URL. + +## How it works + +1. Take any public GitHub repository URL: + ``` + https://github.com/owner/repo + ``` + +2. Replace `github.com` with `mintlify.com`: + ``` + https://mintlify.com/owner/repo + ``` + +3. Enter your email to start generation. You'll receive an email when your site is ready. + +## Generation process + +When you submit a repository, the system: + +1. **Provisions** a new hosted site with a unique subdomain +2. **Analyzes** the repository to discover project context, including: + - README content + - Programming languages used + - GitHub topics and metadata + - Homepage URL and branding assets (colors, logos, favicon) +3. **Generates** content using AI based on your codebase structure +4. **Reviews** the generated content for quality +5. **Deploys** the site and sends you an email with the URL + +The process typically takes 15-30 minutes. + +## Keeping content updated + +Generated sites track the source repository they were created from. The system stores: + +- The source repository URL +- The commit SHA at the time of generation + +This allows the content to be regenerated when the source repository changes, ensuring your site stays current with your codebase. + +## Requirements + +- The repository must be public +- The repository must have a minimum number of GitHub stars + +## Claiming your site + +After your site is generated, you can sign up to claim it and gain access to: + +- The web editor for making changes +- Custom domain configuration +- Analytics and feedback +- All other Mintlify features + +The email you receive after generation includes a link to [sign up and claim your site](https://dashboard.mintlify.com/signup).