Move to Mintlify

README.md

@@ -1,41 +1,13 @@
-Docs for gptengineer.app
-========================
+# These docs are built with Mintlify
 
-Built with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
+To install Mintlify locally
 
-Configuration happens in `mkdocs.yml`. You can find an extensive example [here](https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml).
-
-Docs for the docs:
- - https://mkdocs.org
- - https://squidfunk.github.io/mkdocs-material/
-
-## Build
-
-```bash
-make install
-make build
-# or, to serve locally
-make dev
+```
+npm i -g mintlify
 ```
 
-## What do we need to document?
-
-We want to keep the documentation as simple as possible.
-
- - The documentation should **not** be necessary for users to understand how to use gptengineer.app. 
-   - If users need to read the documentation to understand how to use the app, then the app is not intuitive enough.
- - The documentation should serve as a complement to the app.
-   - Giving users clarity about what it can and cannot do.
- - The documentation could also contain content aimed at developers/power users.
-   - Which might confuse non-technical users if it were included in the app itself.
- - Something to link to when people have questions.
- - Explain status of upcoming/requested features, like backend etc.
-
-## Contributing
-
-We welcome community contributions to improve the documentation. If you would like to contribute, please refer to our [Contributing guide](./CONTRIBUTING.md) for instructions on how to get started.
-
-
-## Deploy
+To test your changes
 
-The documentation is automatically deployed to Netlify from GitHub Actions when changes to the `docs/` directory are made on the `main` branch. (this is due to Netlify not supporting Python 3.8+ in their build workers)
+```
+mintlify dev
+```

src/features/deploy.md → features/deploy.mdx

@@ -1,42 +1,60 @@
-# :globe_with_meridians: Deploy and share
+---
+title: 'Deploy and share'
+description: 'Learn how to deploy and share your web applications with Lovable'
+---
 
-Once your web app is ready, you can deploy it or share it with the world. You can also share your work-in-progress version to gather feedback. Lovable makes it simple to publish and share your apps with just a few clicks.
+Once your web app is ready, you can deploy it or share it with the world. You can also share your work-in-progress version to gather feedback. Lovable makes it simple to publish and share your apps with just a few clicks. 
 
----
+
+
+<Tip>
+  Your published app will be accessible to anyone with the link. Make sure you're ready to share before publishing!
+</Tip>
+
+***
 
 ## Publishing your app
 
 To publish your web app, in the top right corner of the editor view, click on the **Share** button. This button looks like a globe icon.
-<div align="center">
-  <img src="/assets/share-icon.png" alt="Share icon in Lovable">
-</div>
+
+<Frame>
+  <img src="/assets/share-icon.png" alt="Share icon in Lovable" />
+</Frame>
 
 After clicking the **Share** button, a dialog will appear with options to publish your application. Click the green **Publish** button to start the deployment process. During this time, the button will display **Publishing**.
 
-<div align="center">
-    <video autoplay loop src="/assets/videos/video-publish-republish.mp4" title="Publishing and republishing Lovable apps"></video>
-</div>
+<Frame>
+  <video autoPlay loop muted>
+    <source src="/assets/videos/video-publish-republish.mp4" type="video/mp4" />
+  </video>
+</Frame>
 
 Once the deployment is complete, the dialog will show the published address with a **Republish** button for future updates.
 
 Your application is now live, and you can access it at the provided link.
 
----
+<Note>
+  The publishing process typically takes less than a minute. You'll receive a notification once it's complete.
+</Note>
+
+***
 
 ## Previewing your app
 
 Previewing your app allows you to preview and share your work-in-progress updates without fully deploying them.
 
-!!! tip "Use previewing for iterative development"
-    Previewing is very handy as it allows you and others to view the latest changes without affecting the live, published version of your application.
+<Info>
+  **Use previewing for iterative development**
+
+  Previewing is very handy as it allows you and others to view the latest changes without affecting the live, published version of your application.
 
-    We've noticed users using it for iterative development and getting real-time feedback, as well as for collaborative reviews and testing before final deployment.
+  We've noticed users using it for iterative development and getting real-time feedback, as well as for collaborative reviews and testing before final deployment.
+</Info>
 
 Within the same **Share** dialog described earlier, you'll see a **Preview** section with a link to view or share your work-in-progress updates.
 
 The preview link is generated instantly and can be shared with team members for feedback.
-<div align="center">
-  <img src="/assets/share-preview.png" alt="Sharing your work-in-progress">
-</div>
 
-</br></br>
+<Frame>
+  <img src="/assets/share-preview.png" alt="Sharing your work-in-progress" />
+</Frame>

src/features/index.md → features/introduction.mdx

@@ -1,4 +1,8 @@
-# :tools: Features
+---
+title: 'Introduction'
+description: 'Explore the key features and capabilities of Lovable'
+---
+
 
 Lovable comes with a sleeve of features available. While these Docs are work in progress, and not all of the features are described, we wanted to showcase some of the key and most commonly used features.
 
@@ -7,31 +11,21 @@ Lovable comes with a sleeve of features available. While these Docs are work in
 ## Overview
 Explore the sections below to get started quickly and learn more about some of the features offered by Lovable.
 
-<div class="grid cards" markdown>
-
--   :octicons-globe-24:{ .lg .middle } **Deploy and share**
-
-    ---
-
+<CardGroup cols={2}>
+  <Card
+    title="Deploy and share"
+    icon="globe"
+    href="/deploy"
+  >
     Learn how to publish and share your Lovable projects quickly and efficiently with the public.
+  </Card>
 
-    [:octicons-arrow-right-24: Deploy](deploy.md)
-
-
--   :simple-npm:{ .lg .middle } **Using npm packages**
-
-    ---
-
+  <Card
+    title="Using npm packages"
+    icon="npm"
+    href="/npm-packages"
+  >
     Extend Lovable's functionality by integrating npm packages into your projects.
+  </Card>
 
-    [:octicons-arrow-right-24: Using npm packages](npm-packages.md)
-
--   :octicons-stack-24:{ .lg .middle } **Tech stacks**
-
-    ---
-
-    You can select the tech stack Lovable starts from.
-
-    [:octicons-arrow-right-24: Tech stacks](techstacks.md)
-
-</div>
+</CardGroup>