Skip to content

Commit

Permalink
Merge pull request #12 from lovablelabs/vibor-docs
Browse files Browse the repository at this point in the history
Updates assets and branding names
  • Loading branch information
viborc authored Nov 13, 2024
2 parents efb126d + 91d6ca5 commit 7448c90
Show file tree
Hide file tree
Showing 20 changed files with 95 additions and 95 deletions.
8 changes: 4 additions & 4 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Project information
site_name: GPT Engineer Docs
site_name: Lovable Docs
site_url: https://docs.gptengineer.app/
# SEO notice: https://docs.gptengineer.app/sitemap.xml
docs_dir: src
site_description: GPT Engineer app project documentation. Learn more about GPT Engineer, its features and get up to speed.
site_description: Lovable.dev project documentation. Learn more about Lovable.dev, its features and get up to speed.

# Copyright
copyright: "© 2023 - 2024 ❤️ Lovable"
Expand Down Expand Up @@ -39,7 +39,7 @@ nav:
theme:
name: material
locale: en
logo: assets/gpt-engineer-2x-logo.png
logo: assets/lovable-2x-logo.png
favicon: assets/favicon-32x32.png
palette:
# Light mode as default
Expand Down Expand Up @@ -82,7 +82,7 @@ extra:
- icon: fontawesome/solid/heart
link: https://lovable.dev
- icon: fontawesome/brands/twitter
link: https://twitter.com/Lovable_dev
link: https://twitter.com/lovable_dev
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@lovable-labs
- icon: fontawesome/brands/discord
Expand Down
Binary file modified src/assets/favicon-32x32.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed src/assets/gpt-engineer-2x-logo.png
Binary file not shown.
Binary file added src/assets/lovable-2x-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions src/credits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :medal: Messaging limits

LLMs are expensive, because of this GPT Engineer limits the daily and/or monthly messages that result in successful edits you can send.
LLMs are expensive, because of this Lovable limits the daily and/or monthly messages that result in successful edits you can send.

!!! info "Edits expiration"
Daily edits renew at midnight UTC.
Expand All @@ -9,7 +9,7 @@ LLMs are expensive, because of this GPT Engineer limits the daily and/or monthly
## All plans
- **Daily limit** - 5 free messages per day

Designed to give users a chance to explore and experience GPT Engineer's features at no cost.
Designed to give users a chance to explore and experience Lovable's features at no cost.

!!! info "What happens if my edit fails?"
If an edit generation completely fails (build error) due to an error on our side, the credit for that edit will **not** be deducted from your daily/monthly total.
Expand Down
6 changes: 3 additions & 3 deletions src/features/deploy.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# :globe_with_meridians: Deploy and share

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. GPT Engineer 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.

---

## 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 GPT Engineer">
<img src="/assets/share-icon.png" alt="Share icon in Lovable">
</div>

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 GPT Engineer apps"></video>
<video autoplay loop src="/assets/videos/video-publish-republish.mp4" title="Publishing and republishing Lovable apps"></video>
</div>

Once the deployment is complete, the dialog will show the published address with a **Republish** button for future updates.
Expand Down
10 changes: 5 additions & 5 deletions src/features/git-integration.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# :simple-github: GitHub Integration

To make it easier for developers to work together with the AI on projects, gptengineer.app backs all projects with a git repository and lets you push commits directly to the repository.
To make it easier for developers to work together with the AI on projects, Lovable backs all projects with a git repository and lets you push commits directly to the repository.

In order to push commits to GitHub, your project and gptengineer.app will automatically pull them in and update the project. This allows you to make changes yourself, without asking the AI.
In order to push commits to GitHub, your project and Lovable will automatically pull them in and update the project. This allows you to make changes yourself, without asking the AI.

## Connecting a project to your GitHub account

Before pushing your first commit, you will need to connect your GitHub account to the project. You can do this by navigating to GitHub -> Connect to GitHub. You will then be redirected to GitHub to authorize the connection.

You can choose to either granting access to (1) all repositories, or (2) specific repositories. Both options will let GPT Engineer create repositories in your GitHub account or organization.
You can choose to either granting access to (1) all repositories, or (2) specific repositories. Both options will let Lovable create repositories in your GitHub account or organization.

Note that you can only connect one GitHub login to your GPT Engineer account, but you can create repositories in any of the organizations you choose to install the GPT Engineer app in.
Note that you can only connect one GitHub login to your Lovable account, but you can create repositories in any of the organizations you choose to install the Lovable app in.

<video autoplay loop src="/assets/connect-to-github.mp4"> video </video>

Expand All @@ -20,7 +20,7 @@ Please note that you will need admin access if you are trying to create a reposi

Once you have connected your GitHub account to your project, you can view the source code by navigating to GitHub -> View on GitHub.

Any change you make and push to the repository will be automatically reflected in gptengineer.app.
Any change you make and push to the repository will be automatically reflected in Lovable.

You can commit changes directly in GitHub Codespaces or clone the repo to use your preferred IDE.

Expand Down
10 changes: 5 additions & 5 deletions src/features/index.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
# :tools: Features

GPT Engineer 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.
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.

---

## Overview
Explore the sections below to get started quickly and learn more about some of the features offered by GPT Engineer.
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**

---

Learn how to publish and share your GPT Engineer projects quickly and efficiently with the public.
Learn how to publish and share your Lovable projects quickly and efficiently with the public.

[:octicons-arrow-right-24: Deploy](deploy.md)

Expand All @@ -22,15 +22,15 @@ Explore the sections below to get started quickly and learn more about some of t

---

Extend GPT Engineer's functionality by integrating npm packages into your projects.
Extend Lovable's functionality by integrating npm packages into your projects.

[:octicons-arrow-right-24: Using npm packages](npm-packages.md)

- :octicons-stack-24:{ .lg .middle } **Tech stacks**

---

You can configure the tech stack GPT Engineer starts from.
You can select the tech stack Lovable starts from.

[:octicons-arrow-right-24: Tech stacks](techstacks.md)

Expand Down
12 changes: 6 additions & 6 deletions src/features/npm-packages.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :simple-npm: Using npm packages

While GPT Engineer is powerful on its own, enabling users to build sophisticated web applications, you can leverage npm packages for more advanced and extended features. These packages help you build even more complex and feature-rich applications with ease.
While Lovable is powerful on its own, enabling users to build sophisticated web applications, you can leverage npm packages for more advanced and extended features. These packages help you build even more complex and feature-rich applications with ease.

!!! info "What is npm?"
npm (Node Package Manager) is a package manager for JavaScript that allows developers to share and reuse code. It hosts thousands of packages, which are pieces of reusable code, that you can easily integrate into your projects to extend functionality.
Expand All @@ -11,28 +11,28 @@ While GPT Engineer is powerful on its own, enabling users to build sophisticated

## Using npm packages for advanced features

Let's say you'd like to create a tool that enables you to arrange your tasks in different Kanban boards, similar to many popular project management tools. You can prompt GPT Engineer to build this tool from scratch, but it might be slower and more challenging to achieve the desired functionality.
Let's say you'd like to create a tool that enables you to arrange your tasks in different Kanban boards, similar to many popular project management tools. You can prompt Lovable to build this tool from scratch, but it might be slower and more challenging to achieve the desired functionality.

Instead, you can use npm packages to simplify and speed up the process. For example, the <a href="https://www.npmjs.com/package/@hello-pangea/dnd" target="_blank" rel="noopener noreferrer">hello-pangea/dnd</a> package provides robust drag-and-drop functionality. By using this package, you can easily create a Kanban board where users can add new cards, move them within columns, and reorder them.

!!! example "Integrating drag-and-drop npm package"
To incorporate the hello-pangea/dnd package into your GPT Engineer project, you can use the following prompt:
To incorporate the hello-pangea/dnd package into your Lovable project, you can use the following prompt:

```
Use the hello-pangea/dnd npm package to add drag-and-drop functionality to my Kanban board app.
Ensure users can add new cards, move them within columns, and reorder them.

```

This prompt directs GPT Engineer to integrate the package into your project, making it easier to achieve the desired functionality. Depending on other requirements, your result might look somewhat like this.
This prompt directs Lovable to integrate the package into your project, making it easier to achieve the desired functionality. Depending on other requirements, your result might look somewhat like this.

![GPT Engineer implemented drag-and-drop Kanban functionality](/assets/npm-example-using-pangea-dnd.png)
![Lovable implemented drag-and-drop Kanban functionality](/assets/npm-example-using-pangea-dnd.png)

---

## Quality and responsibility

It’s important to note that while npm packages can significantly enhance your projects, GPT Engineer cannot guarantee the quality or reliability of these third-party packages.
It’s important to note that while npm packages can significantly enhance your projects, Lovable cannot guarantee the quality or reliability of these third-party packages.

The functionality and performance of npm packages are the responsibility of the end user, and it’s essential to thoroughly test and validate them within your application.

Expand Down
2 changes: 1 addition & 1 deletion src/free-credits.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# :gift: Get free edits

Help your friends & followers build faster with GPT Engineer. Invite friends to use GPT Engineer, and when they create a project you’ll both earn 25 edits. If you make 30 referrals, you’ll unlock a bonus 250 edits.
Help your friends & followers build faster with Lovable. Invite friends to use Lovable, and when they create a project you’ll both earn 25 edits. If you make 30 referrals, you’ll unlock a bonus 250 edits.

## How to start earning?

Expand Down
4 changes: 2 additions & 2 deletions src/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# :rocket: Getting started

This is a simple tutorial to get you started with the basics of gptengineer.app.
This is a simple tutorial to get you started with the basics of Lovable.

We will guide you through the process of creating a project, making improvements, and deploying your project.

## Creating a project

To create a new project, login to `gptengineer.app` and then write what you want to build in the textbox.
To create a new project, login to `lovable.dev` and then write what you want to build in the textbox.

Once you have written what you want to build, click on the `Create` button.

Expand Down
28 changes: 14 additions & 14 deletions src/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Wecome to Lovable Academy

GPT Engineer is an AI web builder app that lets you build real web apps fast, using just natural language. We prepared this documentation to make it even easier for you to go from an idea to an app and to understand how GPT Engineer works.
Lovable is an AI web builder app that lets you build real web apps fast, using just natural language. We prepared this documentation to make it even easier for you to go from an idea to an app and to understand how Lovable works.

## Product Capabilities

**GPT Engineer** currrently excels at building front-end applications. However, pairing GPT Engineer with other tools will allow you to build full-stack web apps.
**Lovable** currrently excels at building front-end applications. However, pairing Lovable with other tools will allow you to build full-stack web apps.

| **Capability** | **Description** | **Maturity Level** |
|--------------------|------------------------------------------------------------------------------|--------------------|
Expand All @@ -13,7 +13,7 @@ GPT Engineer is an AI web builder app that lets you build real web apps fast, us
| Authentication | Handle user login and accounts (read more [here](integrations/supabase.md#supabase-authentication)) | 🟡 Requires some patience |

## Overview
Explore the sections below to get started quickly and learn more about the features and integrations offered by GPT Engineer.
Explore the sections below to get started quickly and learn more about the features and integrations offered by Lovable.

<div class="grid cards" markdown>

Expand All @@ -29,7 +29,7 @@ Explore the sections below to get started quickly and learn more about the featu

---

From a general overview to our GitHub integration, this section covers the nuts and bolts of GPT Engineer.
From a general overview to our GitHub integration, this section covers the nuts and bolts of Lovable.

[:octicons-arrow-right-24: Features](features/index.md)

Expand All @@ -45,7 +45,7 @@ Explore the sections below to get started quickly and learn more about the featu

---

Learn effective prompting strategies and get the most out of GPT Engineer with our tips and tricks collection.
Learn effective prompting strategies and get the most out of Lovable with our tips and tricks collection.

[:octicons-arrow-right-24: Tips and tricks](tips-tricks/prompting.md)

Expand All @@ -54,9 +54,9 @@ Explore the sections below to get started quickly and learn more about the featu
---

## Learn more
You can learn more about GPT Engineer on our <a href="https://gptengineer.app" target="_blank" rel="noopener noreferrer">website</a>.
You can learn more about Lovable on our <a href="https://lovable.dev" target="_blank" rel="noopener noreferrer">website</a>.
</br></br>
Discover the team behind GPT Engineer and our mission to make web development accessible to everyone. Learn more about the creators at <a href="https://lovable.dev" target="_blank" rel="noopener noreferrer">:heart: Lovable</a>.
Discover the team behind Lovable and our mission to make web development accessible to everyone. Learn more about the creators at <a href="https://lovable.dev" target="_blank" rel="noopener noreferrer">:heart: Lovable</a>.

---

Expand All @@ -82,12 +82,12 @@ If Discord is your thing, then this channel is dedicated to collecting general f

## Support

We use **Discord** and <a href="mailto:support@lovable.dev">**support@lovable.dev**</a> as our support channels for GPT Engineer users.
We use **Discord** and <a href="mailto:support@lovable.dev">**support@lovable.dev**</a> as our support channels for Lovable users.

### Support channel - Community support only
[:simple-discord: Support channel on Discord](https://discord.com/channels/1119885301872070706/1280461670979993613)

This is the community support channel for GPT Engineer app users. It uses a forum-style structure where each issue or bug is addressed in its own thread, making it easier to manage and track. Support is provided by community members and our Community Champions.
This is the community support channel for Lovable app users. It uses a forum-style structure where each issue or bug is addressed in its own thread, making it easier to manage and track. Support is provided by community members and our Community Champions.

When submitting a support request, please follow these guidelines:

Expand All @@ -102,19 +102,19 @@ When submitting a support request, please follow these guidelines:
- **Public posts** - Keep in mind that all posts in this channel are public. Be mindful of any sensitive information in your videos or screenshots.


Community support channel is usually the fastest way to get guidance about issues with GPT Engineer.
Community support channel is usually the fastest way to get guidance about issues with Lovable.

Pro users get priority support from our support team through dedicated channel and <a href="mailto:support@lovable.dev">**support@lovable.dev**</a>. Please ensure that you are using the same email address you used to sign up for GPT Engineer so we can assist you effeciently.
Pro users get priority support from our support team through dedicated channel and <a href="mailto:support@lovable.dev">**support@lovable.dev**</a>. Please ensure that you are using the same email address you used to sign up for Lovable so we can assist you effeciently.

Please note that our team is located in the Europe. While we do our best to reply during our regular business hours — and sometimes outside of them — do keep in mind that over weekends or outside of EU hours, responses may take longer.

We appreciate your understanding. 🫶

---

### General GPT Engineer app channel
[:simple-discord: General GPT Engineer app channel on Discord](https://discord.com/channels/1119885301872070706/1186613291745824868)
### General Lovable app channel
[:simple-discord: General Lovable app channel on Discord](https://discord.com/channels/1119885301872070706/1186613291745824868)

This is an open space for users to discuss anything related to GPT Engineer. Whether it's a feature you love or just a general chat about the app, this is the place to engage with the community.
This is an open space for users to discuss anything related to Lovable. Whether it's a feature you love or just a general chat about the app, this is the place to engage with the community.

</br></br>
6 changes: 3 additions & 3 deletions src/integrations/index.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# :nut_and_bolt: Integrations

GPT Engineer supports several integrations enabling you to extend its functionality.
Lovable supports several integrations enabling you to extend its functionality.

---


## Overview
Explore the sections below to get started quickly and learn more about GitHub and Supabase integrations currently offered by GPT Engineer
Explore the sections below to get started quickly and learn more about GitHub and Supabase integrations currently offered by Lovable
<div class="grid cards" markdown>


- :simple-github:{ .lg .middle } **GitHub integration**

---

Understand how to integrate GPT Engineer with GitHub for seamless version control and collaboration.
Understand how to integrate Lovable with GitHub for seamless version control and collaboration.

[:octicons-arrow-right-24: Git integration](../features/git-integration.md)

Expand Down
Loading

0 comments on commit 7448c90

Please sign in to comment.