Skip to content
Merged
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
10 changes: 10 additions & 0 deletions .agents/skills/code-review.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,13 @@ grep -rn "function_name" /tmp/agent-sdk/
- Ensure MDX frontmatter is present and well-formed
- Check that internal links use absolute doc paths (e.g., `/overview/quickstart`)
- Verify code blocks with file references use the correct sync format (see `sdk-guidelines.md`)

### SDK guide file naming convention

SDK guide files under `sdk/guides/` **must** use a category prefix:

- `llm-` for LLM-related guides (e.g., `llm-reasoning.mdx`, `llm-gpt5-preset.mdx`)
- `agent-` for Agent-related guides (e.g., `agent-custom.mdx`, `agent-delegation.mdx`)
- `convo-` for Conversation-related guides (e.g., `convo-async.mdx`, `convo-persistence.mdx`)

Flag any new SDK guide that does not follow this naming convention.
12 changes: 12 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,18 @@ Workflow: `.github/workflows/sync-agent-sdk-openapi.yml`
- Use Mintlify components (`<Note>`, `<Warning>`, `<Tabs>`, etc.) where appropriate.
- When linking internally, prefer **absolute** doc paths (e.g. `/overview/quickstart`).

### SDK guide file naming

SDK guide files under `sdk/guides/` use a **category prefix** to group related pages:

| Prefix | Category | Examples |
|--------|----------|----------|
| `llm-` | LLM features (model configuration, providers, streaming, presets) | `llm-reasoning.mdx`, `llm-gpt5-preset.mdx` |
| `agent-` | Agent features (customization, delegation, browser, settings) | `agent-custom.mdx`, `agent-delegation.mdx` |
| `convo-` | Conversation features (async, persistence, pause/resume) | `convo-async.mdx`, `convo-persistence.mdx` |

When adding a new SDK guide, always use the appropriate prefix so that related files sort together and the sidebar grouping in `docs.json` stays consistent.

## LLM API Key Options

The SDK documentation maintains three ways for users to obtain LLM access:
Expand Down
2 changes: 1 addition & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@
"sdk/guides/llm-registry",
"sdk/guides/llm-routing",
"sdk/guides/llm-reasoning",
"sdk/guides/gpt5-preset",
"sdk/guides/llm-gpt5-preset",
"sdk/guides/llm-streaming",
"sdk/guides/llm-image-input",
"sdk/guides/llm-error-handling",
Expand Down
File renamed without changes.
Loading