Skip to content

working in progress

0ef374e
Select commit
Loading
Failed to load commit list.
Draft

API docs generator... #305

working in progress
0ef374e
Select commit
Loading
Failed to load commit list.
Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck completed Feb 9, 2026 in 8s

Mintlify Validation (allhandsai) - vale-spellcheck Failed

Found 130 suggested changes across 8 files in 5325.96ms

Details

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

- sdk/api-reference/openhands.sdk.agent.mdx
- sdk/api-reference/openhands.sdk.conversation.mdx
- sdk/api-reference/openhands.sdk.event.mdx
- sdk/api-reference/openhands.sdk.llm.mdx
- sdk/api-reference/openhands.sdk.security.mdx
- sdk/api-reference/openhands.sdk.tool.mdx
- sdk/api-reference/openhands.sdk.utils.mdx
- sdk/api-reference/openhands.sdk.workspace.mdx

Attempting to initialize Vale linter...
No customer vale configuration detected. Using Mintlify's default configuration.
Attempting to run Vale spellcheck...
Vale spellcheck completed successfully.

sdk/api-reference/openhands.sdk.agent.mdx:
	- 77:1      'LLM' is repeated!
	- 93:12     Did you really mean 'kwargs'?
	- 132:3     Did you really mean 'abstractmethod'?
	- 184:31    Did you really mean 'agent_context'?
	- 214:6     Did you really mean 'model_dump'?
	- 231:19    Did you really mean 'dataclasses'?

sdk/api-reference/openhands.sdk.conversation.mdx:
	- 37:3       Did you really mean 'abstractmethod'?
	- 62:3       Did you really mean 'abstractmethod'?
	- 71:3       Did you really mean 'abstractmethod'?
	- 82:3       Did you really mean 'abstractmethod'?
	- 93:3       Did you really mean 'abstractmethod'?
	- 102:3      Did you really mean 'abstractmethod'?
	- 106:3      Did you really mean 'abstractmethod'?
	- 115:3      Did you really mean 'abstractmethod'?
	- 119:3      Did you really mean 'abstractmethod'?
	- 176:3      Did you really mean 'abstractmethod'?
	- 201:3      Did you really mean 'abstractmethod'?
	- 219:3      Did you really mean 'abstractmethod'?
	- 240:63     Did you really mean 'sleeptime_compute'?
	- 270:45     Did you really mean 'iterable'?
	- 324:38     Did you really mean 'event_id'?
	- 335:12     Did you really mean 'event_id'?
	- 369:3      Did you really mean 'abstractmethod'?
	- 421:19     Did you really mean 'LLMRegistry'?
	- 457:48     Did you really mean 'repo_path'?
	- 458:1      Did you really mean 'monorepos'?
	- 465:31     Did you really mean 'filestore'?
	- 479:26     Did you really mean 'action_observation'?
	- 479:48     Did you really mean 'action_error'?
	- 480:21     Did you really mean 'alternating_pattern'?
	- 625:17     Did you really mean 'agent_waiting_for_confirmation'?
	- 653:94     Did you really mean 'callables'?
	- 654:45     Did you really mean 'Callables'?
	- 766:63     Did you really mean 'sleeptime_compute'?
	- 819:51     Did you really mean 'repo_path'?
	- 826:26     Did you really mean 'action_observation'?
	- 826:48     Did you really mean 'action_error'?
	- 827:21     Did you really mean 'alternating_pattern'?
	- 1025:83    Did you really mean 'usage_id'?
	- 1137:10    Did you really mean 'expose_secrets'?
	- 1137:56    Did you really mean 'dunped'?
	- 1210:19    Did you really mean 'callables'?
	- 1325:38    Did you really mean 'Pydantic'?
	- 1332:1     Did you really mean 'agent_context'?
	- 1354:53    Did you really mean 'Pydantic'?
	- 1581:23    Did you really mean 'uninstantiated'?
	- 1620:3     Did you really mean 'abstractmethod'?

sdk/api-reference/openhands.sdk.event.mdx:
	- 35:3       Did you really mean 'abstractmethod'?
	- 78:30      Did you really mean 'summary_offset'?
	- 214:11     Did you really mean 'usage_id'?
	- 238:111    Did you really mean 'messageThis'?
	- 246:96     Did you really mean 'explainability'?
	- 264:57     Did you really mean 'reasoning_content'?
	- 296:69     Did you really mean 'eventIf'?

sdk/api-reference/openhands.sdk.llm.mdx:
	- 41:53      Did you really mean 'openai'?
	- 292:29     Did you really mean 'litellm'?
	- 328:54     Did you really mean 'lookups'?
	- 328:228    Did you really mean 'proxied'?
	- 340:24     Did you really mean 'litellm'?
	- 350:53     Did you really mean 'log_completions'?
	- 352:12     Did you really mean 'tokenizer'?
	- 356:30     Did you really mean 'serializer'?
	- 356:189    Did you really mean 'Groq'?
	- 357:57     Did you really mean 'xhigh'?
	- 372:58     Did you really mean 'lookups'?
	- 374:41     Did you really mean 'litellm'?
	- 417:19     Did you really mean 'LLMResponse'?
	- 431:8      Did you really mean 'security_risk'?
	- 437:4      Did you really mean 'LLMResponse'?
	- 437:17     Did you really mean 'LLMResponse'?
	- 473:18     Did you really mean 'LLMResponse'?
	- 479:55     Did you really mean 'LLMResponse'?
	- 488:8      Did you really mean 'security_risk'?
	- 570:41     Did you really mean 'serializer'?
	- 574:45     Did you really mean 'prepended'?
	- 620:4      Did you really mean 'openai'?
	- 630:69     Did you really mean 'openai'?
	- 673:10     Did you really mean 'LLMRegistry'?
	- 678:31     Did you really mean 'LLMs'?
	- 713:72     Did you really mean 'LLMs'?
	- 770:19     Did you really mean 'usage_id'?
	- 792:10     Did you really mean 'LLMResponse'?
	- 868:17     Did you really mean 'serializer'?
	- 869:9      Did you really mean 'reasoning_content'?
	- 871:33     Did you really mean 'serializer'?
	- 921:50     Did you really mean 'input_text'?
	- 921:63     Did you really mean 'input_image'?
	- 923:47     Did you really mean 'input_text'?
	- 924:5      Did you really mean 'function_call'?
	- 924:29     Did you really mean 'tool_calls'?
	- 925:15     Did you really mean 'function_call_output'?
	- 926:15     Did you really mean 'call_id'?
	- 955:43     Did you really mean 'output_text'?
	- 956:13     Did you really mean 'function_call'?
	- 970:15     Did you really mean 'function_call_output'?
	- 970:36     Did you really mean 'call_id'?
	- 1000:56    Did you really mean 'function_call'?
	- 1013:38    Did you really mean 'tool_calls'?
	- 1019:32    Did you really mean 'function_call'?
	- 1027:22    Did you really mean 'encrypted_content'?
	- 1110:23    Did you really mean 'LLMs'?
	- 1110:43    Did you really mean 'llms_for_routing'?
	- 1133:19    Did you really mean 'LLMResponse'?
	- 1145:8     Did you really mean 'security_risk'?
	- 1179:3     Did you really mean 'abstractmethod'?
	- 1187:10    Did you really mean 'llms_for_routing'?
	- 1196:45    Did you really mean 'llms_for_routing'?

sdk/api-reference/openhands.sdk.security.mdx:
	- 46:9    Did you really mean 'risk_level'?

sdk/api-reference/openhands.sdk.tool.mdx:
	- 290:25    Did you really mean 'conv_state'?
	- 311:3     Did you really mean 'abstractmethod'?
	- 319:6     Did you really mean 'conv_state'?
	- 323:54    Did you really mean 'conv_state'?
	- 323:74    Did you really mean 'arg'?
	- 426:65    Did you really mean 'action_type'?
	- 427:20    Did you really mean 'MCPTool'?

sdk/api-reference/openhands.sdk.utils.mdx:
	- 12:65    Did you really mean 'vendored'?
	- 13:66    Did you really mean 'subprocess'?
	- 58:69    Did you really mean 'accessors'?

sdk/api-reference/openhands.sdk.workspace.mdx:
	- 12:22     Did you really mean 'sandboxed'?
	- 22:3      Did you really mean 'abstractmethod'?
	- 36:53     Did you really mean 'exit_code'?
	- 58:3      Did you really mean 'abstractmethod'?
	- 87:3      Did you really mean 'abstractmethod'?
	- 116:3     Did you really mean 'abstractmethod'?
	- 139:3     Did you really mean 'abstractmethod'?
	- 231:47    Did you really mean 'exit_code'?
	- 232:1     Did you really mean 'timeout_occurred'?
	- 413:38    Did you really mean 'sandboxed'?
	- 434:50    Did you really mean 'api_key'?
	- 454:47    Did you really mean 'exit_code'?


Found 130 suggested changes across 8 files in 5325.96ms

Annotations

Check warning on line 77 in sdk/api-reference/openhands.sdk.agent.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.agent.mdx#L77

'LLM' is repeated!

Check warning on line 93 in sdk/api-reference/openhands.sdk.agent.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.agent.mdx#L93

Did you really mean 'kwargs'?

Check warning on line 132 in sdk/api-reference/openhands.sdk.agent.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.agent.mdx#L132

Did you really mean 'abstractmethod'?

Check warning on line 184 in sdk/api-reference/openhands.sdk.agent.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.agent.mdx#L184

Did you really mean 'agent_context'?

Check warning on line 214 in sdk/api-reference/openhands.sdk.agent.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.agent.mdx#L214

Did you really mean 'model_dump'?

Check warning on line 231 in sdk/api-reference/openhands.sdk.agent.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.agent.mdx#L231

Did you really mean 'dataclasses'?

Check warning on line 37 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L37

Did you really mean 'abstractmethod'?

Check warning on line 62 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L62

Did you really mean 'abstractmethod'?

Check warning on line 71 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L71

Did you really mean 'abstractmethod'?

Check warning on line 82 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L82

Did you really mean 'abstractmethod'?

Check warning on line 93 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L93

Did you really mean 'abstractmethod'?

Check warning on line 102 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L102

Did you really mean 'abstractmethod'?

Check warning on line 106 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L106

Did you really mean 'abstractmethod'?

Check warning on line 115 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L115

Did you really mean 'abstractmethod'?

Check warning on line 119 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L119

Did you really mean 'abstractmethod'?

Check warning on line 176 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L176

Did you really mean 'abstractmethod'?

Check warning on line 201 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L201

Did you really mean 'abstractmethod'?

Check warning on line 219 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L219

Did you really mean 'abstractmethod'?

Check warning on line 240 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L240

Did you really mean 'sleeptime_compute'?

Check warning on line 270 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L270

Did you really mean 'iterable'?

Check warning on line 324 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L324

Did you really mean 'event_id'?

Check warning on line 335 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L335

Did you really mean 'event_id'?

Check warning on line 369 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L369

Did you really mean 'abstractmethod'?

Check warning on line 421 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L421

Did you really mean 'LLMRegistry'?

Check warning on line 457 in sdk/api-reference/openhands.sdk.conversation.mdx

See this annotation in the file changed.

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

sdk/api-reference/openhands.sdk.conversation.mdx#L457

Did you really mean 'repo_path'?