Skip to content

Commit 0748fd2

Browse files
fix(docs): sanitize emoji shortcodes in generated SDK docs (#631)
2 parents 012893a + 079c5cd commit 0748fd2

1,431 files changed

Lines changed: 7757 additions & 7724 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/docs-nav.yaml‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ on:
88
workflow_dispatch:
99
pull_request:
1010
paths:
11-
- "docs/sdks/**"
11+
- "docs/**"
12+
- "scripts/sanitize-docs-emoji.sh"
1213
- "scripts/gen-docs-nav.sh"
1314
- ".github/workflows/docs-nav.yaml"
1415

@@ -23,6 +24,9 @@ jobs:
2324
token: ${{ secrets.GITHUB_TOKEN }}
2425

2526
# jq is preinstalled on GitHub-hosted ubuntu runners.
27+
- name: Sanitize generated docs emoji
28+
run: scripts/sanitize-docs-emoji.sh
29+
2630
- name: Regenerate docs navigation
2731
run: scripts/gen-docs-nav.sh
2832

‎docs/components/aabenchmarkentry.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Artificial Analysis benchmark index scores.
99

1010
| Field | Type | Required | Description | Example |
1111
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
12-
| `agentic_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 |
13-
| `coding_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 |
14-
| `intelligence_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 |
12+
| `agentic_index` | *Nullable[float]* | ✅ | Artificial Analysis Agentic Index score | 55.8 |
13+
| `coding_index` | *Nullable[float]* | ✅ | Artificial Analysis Coding Index score | 63.2 |
14+
| `intelligence_index` | *Nullable[float]* | ✅ | Artificial Analysis Intelligence Index score | 71.4 |

‎docs/components/activityitem.mdx‎

Lines changed: 13 additions & 13 deletions
Large diffs are not rendered by default.

‎docs/components/activityresponse.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@ title: "ActivityResponse"
66

77
| Field | Type | Required | Description |
88
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
9-
| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | :heavy_check_mark: | List of activity items |
9+
| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | ✅ | List of activity items |

‎docs/components/additionaltoolsitem.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Additional tools made available to the model at this point in the input
99

1010
| Field | Type | Required | Description |
1111
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
12-
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
13-
| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A |
14-
| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | :heavy_check_mark: | N/A |
15-
| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A |
12+
| `id` | *OptionalNullable[str]* | ➖ | N/A |
13+
| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | ✅ | N/A |
14+
| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | ✅ | N/A |
15+
| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | ✅ | N/A |

‎docs/components/additionaltoolsitemtool.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ title: "AdditionalToolsItemTool"
66

77
| Field | Type | Required | Description |
88
| -------------------- | -------------------- | -------------------- | -------------------- |
9-
| `type` | *str* | :heavy_check_mark: | N/A |
10-
| `__pydantic_extra__` | Dict[str, *Any*] | :heavy_minus_sign: | N/A |
9+
| `type` | *str* | ✅ | N/A |
10+
| `__pydantic_extra__` | Dict[str, *Any*] | ➖ | N/A |

0 commit comments

Comments
 (0)