docs(sdk): add normative invariants to architecture docs #274

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.

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

Open

enyst wants to merge 7 commits into main

from openhands/sdk-arch-1815

Merge branch 'main' into openhands/sdk-arch-1815

7ba7a10

Mintlify / Mintlify Validation (allhandsai) - vale-spellcheck completed Feb 18, 2026 in 10s

Mintlify Validation (allhandsai) - vale-spellcheck Failed

Found 58 suggested changes across 6 files in 6860.32ms

Details

Running Vale across on the following files affected by this PR:
- sdk/arch/agent.mdx
- sdk/arch/condenser.mdx
- sdk/arch/conversation.mdx
- sdk/arch/design.mdx
- sdk/arch/events.mdx
- sdk/arch/tool-system.mdx
- sdk/arch/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/arch/agent.mdx:
	- 150:5 Did you really mean 'Interruptible'?
	- 274:52 Did you really mean 'iff'?
sdk/arch/conversation.mdx:
	- 67:158 Did you really mean 'Pydantic'?
	- 181:34 Did you really mean 'pluggable'?
	- 186:153 Did you really mean 'Debounced'?
	- 217:31 Did you really mean 'iff'?
sdk/arch/design.mdx:
	- 9:436 Did you really mean 'sandboxing'?
	- 11:38 Did you really mean 'Sandboxing'?
	- 20:3 Did you really mean 'Sandboxing'?
	- 21:87 Did you really mean 'MCP's'?
	- 33:32 Did you really mean 'LLMs'?
	- 33:72 Did you really mean 'Pydantic'?
	- 50:4 Did you really mean 'Composable'?
	- 58:24 Did you really mean 'composable'?
	- 59:76 Did you really mean 'LLMs'?
	- 59:110 Did you really mean 'declaratively'?
	- 60:53 Did you really mean 'toolsets'?
	- 79:44 Did you really mean 'Pydantic'?
	- 95:34 Did you really mean 'runtimes'?
sdk/arch/events.mdx:
	- 14:52 Did you really mean 'Pydantic'?
	- 66:149 Did you really mean 'Pydantic'?
	- 150:62 Did you really mean 'Pydantic'?
	- 166:40 Did you really mean 'llm_response_id'?
	- 248:48 Did you really mean 'tool_name'?
	- 248:62 Did you really mean 'tool_call_id'?
sdk/arch/tool-system.mdx:
	- 14:61 Did you really mean 'Pydantic'?
	- 15:80 Did you really mean 'Pydantic'?
	- 67:182 Did you really mean 'subclassed'?
	- 68:136 Did you really mean 'Pydantic'?
	- 69:142 Did you really mean 'Pydantic'?
	- 71:164 Did you really mean 'readOnly'?
	- 71:199 Did you really mean 'openWorld'?
	- 144:17 Did you really mean 'Pydantic'?
	- 145:22 Did you really mean 'Pydantic'?
	- 221:186 Did you really mean 'LLMs'?
	- 232:20 Did you really mean 'LLMs'?
	- 287:96 Did you really mean 'classmethod'?
	- 305:34 Did you really mean 'Pydantic'?
	- 312:57 Did you really mean 'tools_map'?
	- 345:57 Did you really mean 'discoverability'?
	- 401:192 Did you really mean 'MCPClient'?
	- 404:163 Did you really mean 'Pydantic'?
	- 477:34 Did you really mean 'Pydantic'?
	- 488:39 Did you really mean 'Pydantic'?
	- 549:25 Did you really mean 'tools_map'?
	- 550:11 Did you really mean 'tools_map'?
	- 551:5 Did you really mean 'tools_map'?
	- 552:13 Did you really mean 'tools_map'?
	- 553:5 Did you really mean 'tools_map'?
	- 554:5 Did you really mean 'tools_map'?
	- 561:61 Did you really mean 'configs'?
sdk/arch/workspace.mdx:
	- 71:192 Did you really mean 'exit_code'?
	- 81:26 Did you really mean 'subprocess'?
	- 84:39 Did you really mean 'Sandboxed'?
	- 121:5 Did you really mean 'exit_code'?
	- 146:5 Did you really mean 'working_dir'?
	- 177:93 Did you really mean 'pausable'?
	- 231:67 Did you really mean 'untrusted'?
Found 58 suggested changes across 6 files in 6860.32ms