Skip to content

Add reference documentation use cases guide #3587

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 2 commits into from

Update docs.json

c72c81c
Select commit
Loading
Failed to load commit list.
Closed

Add reference documentation use cases guide #3587

Update docs.json
c72c81c
Select commit
Loading
Failed to load commit list.
Mintlify / Mintlify Validation (mintlify) - vale-spellcheck completed Feb 20, 2026 in 2s

Mintlify Validation (mintlify) - vale-spellcheck Failed

Found 8 suggested changes across 1 files in 589.67ms

Details

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

- guides/reference-use-cases.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.

guides/reference-use-cases.mdx:
	- 6:94     Use 'capability' or 'feature' instead of 'functionality'.
	- 24:5     Did you really mean 'Scannability'?
	- 25:48    'rarely-used' doesn't need a hyphen.
	- 33:51    Did you really mean 'quickstarts'?
	- 40:10    Spell out 'REST', if it's unfamiliar to the audience.
	- 40:41    Spell out 'RPC', if it's unfamiliar to the audience.
	- 40:41    Use 'rpc' instead of 'RPC'.
	- 71:58    In general, use active voice instead of passive voice ('are required').


Found 8 suggested changes across 1 files in 589.67ms

Annotations

Check warning on line 6 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L6 

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

Check warning on line 24 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L24 

Did you really mean 'Scannability'?

Check warning on line 25 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L25 

'rarely-used' doesn't need a hyphen.

Check warning on line 33 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L33 

Did you really mean 'quickstarts'?

Check warning on line 40 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L40 

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

Check warning on line 40 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L40 

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

Check warning on line 40 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L40 

Use 'rpc' instead of 'RPC'.

Check warning on line 71 in guides/reference-use-cases.mdx

See this annotation in the file changed.

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

guides/reference-use-cases.mdx#L71 

In general, use active voice instead of passive voice ('are required').
View more details on Mintlify