Skip to content
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
2 changes: 1 addition & 1 deletion agent/customize.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
Add any instructions that you want the agent to follow. The agent appends these instructions to its system prompt, so the instructions apply to all tasks whether you use the agent in your dashboard, on Slack, or via the API.

<Note>
The agent only reads `AGENTS.md`. It does not read other agent instruction files that may exist in your repository, such as `CLAUDE.md`, `.cursorrules`, `.github/copilot-instructions.md`, or `GEMINI.md`, even if your `AGENTS.md` references them.

Check warning on line 18 in agent/customize.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

agent/customize.mdx#L18

Use 'GitHub' instead of 'github'.

If you use other tools that rely on their own instruction files, consolidate the instructions you want the Mintlify agent to follow into `.mintlify/AGENTS.md`. You can keep your other files for those tools, but duplicate any shared guidance into `AGENTS.md` so the agent picks it up.
</Note>
Expand Down Expand Up @@ -55,4 +55,4 @@
- Add prerequisite sections to guides when users need API keys, environment setup, or dependencies.
- Include "Next steps" sections linking to related documentation.
- Add troubleshooting sections for common issues we see in support tickets.
```
```
4 changes: 2 additions & 2 deletions api-playground/graphql-setup.mdx
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "GraphQL setup"
description: "Generate reference pages for your GraphQL API from a schema definition file, with linked types and example queries, mutations, and responses."
description: "Hello there"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Placeholder GraphQL page description

Medium Severity

The GraphQL setup page description was replaced with Hello there instead of a real summary of the page. That placeholder will show in search, SEO snippets, and page previews, so readers no longer get an accurate description of GraphQL reference generation.

Fix in Cursor Fix in Web

Reviewed by Cursor Bugbot for commit 8688562. Configure here.

keywords: ["graphql", "schema", "sdl"]
---

## Add a GraphQL schema

To create pages for your GraphQL API, you need a valid GraphQL schema in SDL (Schema Definition Language) format. Store the schema in your documentation repository or host it at an HTTPS URL that Mintlify can fetch.

Check warning on line 9 in api-playground/graphql-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/graphql-setup.mdx#L9

Spell out 'SDL', if it's unfamiliar to the audience.

```graphql schema.graphql
"An object with a stable identifier."
Expand Down Expand Up @@ -75,7 +75,7 @@
</Note>

<ParamField path="source" type="string" required>
A local path to an SDL file in your documentation repository or an HTTPS URL to a hosted SDL file. Does not accept HTTP URLs.

Check warning on line 78 in api-playground/graphql-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/graphql-setup.mdx#L78

Spell out 'SDL', if it's unfamiliar to the audience.

Check warning on line 78 in api-playground/graphql-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/graphql-setup.mdx#L78

Spell out 'SDL', if it's unfamiliar to the audience.
</ParamField>

<ParamField path="directory" type="string">
Expand All @@ -100,4 +100,4 @@

## Update your documentation

Mintlify regenerates GraphQL reference pages when you run `mint dev` or when you push changes to your documentation repository. If your schema is hosted at an HTTPS URL, updates to the schema regenerate on the next build.
Mintlify regenerates GraphQL reference pages when you run `mint dev` or when you push changes to your documentation repository. If your schema is hosted at an HTTPS URL, updates to the schema regenerate on the next build.

Check warning on line 103 in api-playground/graphql-setup.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api-playground/graphql-setup.mdx#L103

In general, use active voice instead of passive voice ('is hosted').
2 changes: 1 addition & 1 deletion automations/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ Deleting an automation is permanent and removes its configuration and run histor

1. Open the [Automations](https://app.mintlify.com/products/automations) page in your dashboard.
2. Click the <Icon icon="settings" /> settings button beside an automation.
3. Click **Delete**.
3. Click **Delete**.
4 changes: 1 addition & 3 deletions quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,13 @@
2. Run `mint --version`. If the command is unavailable, install the CLI with `npm i -g mint` or `pnpm add -g mint`. If the command succeeds, run `mint update`.
3. Run `mint status` before starting authentication. If it already shows an organization, keep the existing session and do not create another account.
4. Run `mint login` if the user has an account. Otherwise, ask for their first name, last name, company, and email, then run:

```bash
mint signup \
--firstName <first-name> \
--lastName <last-name> \
--company <company> \
--email <email>
```

`mint signup` waits for email verification, so keep it running as a background process when your environment supports background commands. Tell the user to click the verification link and approve the CLI in the browser. Never invent signup details.
5. After the user finishes verification and onboarding, run `mint status` again. Confirm that it reports their email, organization, and subdomain. If the organization exists but no subdomain appears, ask the user to finish selecting or connecting a GitHub repository in the onboarding browser tab, then retry.
6. If the user has an existing documentation repository, clone or open it. Preserve its content. For a new local project, scaffold into a new, empty directory with either `mint new <directory> --name <name> --theme <theme>` or `mint new <directory> --template <template-name>`. Ask which theme or template they want if they have not specified one. Do not use `--force` on a directory containing user files.
Expand Down Expand Up @@ -71,7 +69,7 @@
</Visibility>

<Visibility for="agents">
Use the preceding CLI setup workflow. Initiate the corresponding `mint signup` or `mint login` command. Account verification and GitHub authorization open browser pages; have the user approve them. Continue the setup when they finish. Do not consider setup complete until `mint status` reports a subdomain and the deployed `.mintlify.site` URL loads.

Check warning on line 72 in quickstart.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

quickstart.mdx#L72

Use semicolons judiciously.
</Visibility>

## View your deployed site
Expand Down Expand Up @@ -203,4 +201,4 @@

<Card title="Add a custom domain" icon="globe" horizontal href="/customize/custom-domain">
Use your own domain for your documentation site.
</Card>
</Card>