Skip to content

Commit 1c59f95

Browse files
authored
Merge pull request #14 from lovablelabs/mintlify
Move to Mintlify
2 parents 7448c90 + da785e4 commit 1c59f95

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1159
-1570
lines changed

.github/workflows/docs.yml

Lines changed: 0 additions & 44 deletions
This file was deleted.

CONTRIBUTING.md

Lines changed: 0 additions & 32 deletions
This file was deleted.

Makefile

Lines changed: 0 additions & 8 deletions
This file was deleted.

README.md

Lines changed: 8 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,13 @@
1-
Docs for gptengineer.app
2-
========================
1+
# These docs are built with Mintlify
32

4-
Built with [MkDocs](https://www.mkdocs.org/) and [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/).
3+
To install Mintlify locally
54

6-
Configuration happens in `mkdocs.yml`. You can find an extensive example [here](https://github.com/squidfunk/mkdocs-material/blob/master/mkdocs.yml).
7-
8-
Docs for the docs:
9-
- https://mkdocs.org
10-
- https://squidfunk.github.io/mkdocs-material/
11-
12-
## Build
13-
14-
```bash
15-
make install
16-
make build
17-
# or, to serve locally
18-
make dev
5+
```
6+
npm i -g mintlify
197
```
208

21-
## What do we need to document?
22-
23-
We want to keep the documentation as simple as possible.
24-
25-
- The documentation should **not** be necessary for users to understand how to use gptengineer.app.
26-
- If users need to read the documentation to understand how to use the app, then the app is not intuitive enough.
27-
- The documentation should serve as a complement to the app.
28-
- Giving users clarity about what it can and cannot do.
29-
- The documentation could also contain content aimed at developers/power users.
30-
- Which might confuse non-technical users if it were included in the app itself.
31-
- Something to link to when people have questions.
32-
- Explain status of upcoming/requested features, like backend etc.
33-
34-
## Contributing
35-
36-
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.
37-
38-
39-
## Deploy
9+
To test your changes
4010

41-
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)
11+
```
12+
mintlify dev
13+
```
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)