Skip to content

Document assistant and search in local development #5140

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.

Sign up for GitHub

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

Closed
mintlify wants to merge 1 commit into from
Closed

Document assistant and search in local development #5140

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions ai/assistant.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -298,6 +298,12 @@
- **Open with a pre-filled query**: Append `?assistant=YOUR_QUERY` to open the assistant and automatically submit a question.
- Example: [https://mintlify.com/docs?assistant=explain webhooks](https://mintlify.com/docs?assistant=explain%20webhooks)

## Local development

The assistant is available in local development when you are logged into the CLI. Run `mint login` to authenticate, then start your local preview with `mint dev`. The assistant uses your published documentation's indexed content during local development.

Check warning on line 303 in ai/assistant.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

ai/assistant.mdx#L303 

In general, use active voice instead of passive voice ('are logged').

See [Search and assistant in local preview](/installation#search-and-assistant-in-local-preview) for setup instructions.

## Troubleshooting

<Accordion title="Assistant chat bar not visible">
Expand Down
22 changes: 22 additions & 0 deletions installation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,28 @@
npx mint dev
```

### Search and assistant in local preview

Log in to the CLI to enable search and the [AI assistant](/ai/assistant) during local development. Run `mint login` to authenticate with your Mintlify account:

```bash
mint login
```

After logging in, search and the assistant are available in your local preview. The assistant uses the same configuration and indexed content as your published documentation site.

Check warning on line 106 in installation.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

installation.mdx#L106 

Use the Oxford comma in 'After logging in, search and'.

To check your current authentication status:

```bash
mint status
```

To log out:

```bash
mint logout
```

### Custom ports

By default, the CLI uses port 3000. You can customize the port using the `--port` flag. To run the CLI on port 3333, for instance, use this command:
Expand Down
Loading