Skip to content

docs retreat overhaul #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .gitignore

This file was deleted.

32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Mintlify Starter Kit

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including

- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components

### Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

Run the following command at the root of your documentation (where docs.json is)

```
mintlify dev
```

### Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `docs.json`
16 changes: 0 additions & 16 deletions advanced/dashboard/permissions.mdx

This file was deleted.

94 changes: 0 additions & 94 deletions advanced/dashboard/sso.mdx

This file was deleted.

39 changes: 0 additions & 39 deletions advanced/mcp/generate.mdx

This file was deleted.

95 changes: 0 additions & 95 deletions advanced/mcp/quickstart.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions advanced/rest-api/chat/create-topic.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions advanced/rest-api/chat/generate-message.mdx

This file was deleted.

42 changes: 0 additions & 42 deletions advanced/rest-api/overview.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions advanced/rest-api/update/status.mdx

This file was deleted.

3 changes: 0 additions & 3 deletions advanced/rest-api/update/trigger.mdx

This file was deleted.

Loading