Skip to content

Update api/assistant/search.mdx

3380fd6
Select commit
Loading
Failed to load commit list.
Open

Improve search documentation #2324

Update api/assistant/search.mdx
3380fd6
Select commit
Loading
Failed to load commit list.
Mintlify / Mintlify Validation (mintlify) - vale-spellcheck completed Dec 15, 2025 in 6s

Mintlify Validation (mintlify) - vale-spellcheck Failed

Found 21 suggested changes across 2 files in 3334.81ms

Details

Running Vale across on the following files affected by this PR:

- api/assistant/search.mdx
- organize/settings.mdx

Attempting to initialize Vale linter...
Customer vale configuration detected. Attempting to sync packages...
Packages synced successfully.
Attempting to run Vale spellcheck...
Vale spellcheck completed successfully.

api/assistant/search.mdx:
	- 12:44    Use 'app' instead of 'application'.
	- 13:21    Did you really mean 'chatbots'?
	- 30:33    Use parentheses judiciously.
	- 30:34    Use 'for example' instead of 'e.g.'.
	- 30:47    Avoid first-person pronouns such as ' I '.
	- 31:32    Use 'for example' instead of 'e.g.'.

organize/settings.mdx:
	- 53:128     Avoid using 'will'.
	- 118:73     In general, use active voice instead of passive voice ('are supported').
	- 553:155    In general, use active voice instead of passive voice ('is expanded').
	- 563:75     Avoid using 'will'.
	- 641:43     Use parentheses judiciously.
	- 675:5      'API Configurations' should use sentence-style capitalization.
	- 785:5      Spell out 'SEO', if it's unfamiliar to the audience.
	- 785:5      'SEO and search' should use sentence-style capitalization.
	- 788:3      Spell out 'SEO', if it's unfamiliar to the audience.
	- 805:66     Commas and periods go inside quotation marks.
	- 805:73     In general, don't use an ellipsis.
	- 816:12     Use 'capability' or 'feature' instead of 'functionality'.
	- 818:35     Use 'capability' or 'feature' instead of 'functionality'.
	- 828:108    In general, use active voice instead of passive voice ('are indexed').
	- 837:56     In general, use active voice instead of passive voice ('are excluded').


Found 21 suggested changes across 2 files in 3334.81ms

Annotations

Check warning on line 12 in api/assistant/search.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/search.mdx#L12

Use 'app' instead of 'application'.

Check warning on line 13 in api/assistant/search.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/search.mdx#L13

Did you really mean 'chatbots'?

Check warning on line 30 in api/assistant/search.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/search.mdx#L30

Use parentheses judiciously.

Check warning on line 30 in api/assistant/search.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/search.mdx#L30

Use 'for example' instead of 'e.g.'.

Check warning on line 30 in api/assistant/search.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/search.mdx#L30

Avoid first-person pronouns such as ' I '.

Check warning on line 31 in api/assistant/search.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

api/assistant/search.mdx#L31

Use 'for example' instead of 'e.g.'.

Check warning on line 53 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L53

Avoid using 'will'.

Check warning on line 118 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L118

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

Check warning on line 553 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L553

In general, use active voice instead of passive voice ('is expanded').

Check warning on line 563 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L563

Avoid using 'will'.

Check warning on line 641 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L641

Use parentheses judiciously.

Check warning on line 675 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L675

'API Configurations' should use sentence-style capitalization.

Check warning on line 785 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L785

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

Check warning on line 785 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L785

'SEO and search' should use sentence-style capitalization.

Check warning on line 788 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L788

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

Check warning on line 805 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L805

Commas and periods go inside quotation marks.

Check warning on line 805 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L805

In general, don't use an ellipsis.

Check warning on line 816 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L816

Use 'capability' or 'feature' instead of 'functionality'.

Check warning on line 818 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L818

Use 'capability' or 'feature' instead of 'functionality'.

Check warning on line 828 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L828

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

Check warning on line 837 in organize/settings.mdx

See this annotation in the file changed.

@mintlify mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L837

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