Skip to content

fix(docs): sanitize emoji shortcodes in generated SDK docs #631

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

Merged
christineschen merged 5 commits into from
Oct 6, 2026
Merged

fix(docs): sanitize emoji shortcodes in generated SDK docs #631

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
e4f7bcd
fix(docs): sanitize generated emoji shortcodes
devin-ai-integration[bot] Oct 6, 2026
b3e8c4f
fix(docs): ignore URN-style colons in residual shortcode guard
devin-ai-integration[bot] Oct 6, 2026
40f5e23
chore(docs): sanitize generated emoji shortcodes
devin-ai-integration[bot] Oct 6, 2026
a452a51
fix(docs): make residual shortcode guard portable and fail on scan er…
devin-ai-integration[bot] Oct 6, 2026
079c5cd
Merge remote-tracking branch 'origin/main' into devin/1786394635-fix-…
devin-ai-integration[bot] Oct 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 5 additions & 1 deletion .github/workflows/docs-nav.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ on:
workflow_dispatch:
pull_request:
paths:
- "docs/sdks/**"
- "docs/**"
- "scripts/sanitize-docs-emoji.sh"
- "scripts/gen-docs-nav.sh"
- ".github/workflows/docs-nav.yaml"

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

# jq is preinstalled on GitHub-hosted ubuntu runners.
- name: Sanitize generated docs emoji
run: scripts/sanitize-docs-emoji.sh

- name: Regenerate docs navigation
run: scripts/gen-docs-nav.sh

Expand Down
6 changes: 3 additions & 3 deletions docs/components/aabenchmarkentry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ Artificial Analysis benchmark index scores.

| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `agentic_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 |
| `coding_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 |
| `intelligence_index` | *Nullable[float]* | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 |
| `agentic_index` | *Nullable[float]* | ✅ | Artificial Analysis Agentic Index score | 55.8 |
| `coding_index` | *Nullable[float]* | ✅ | Artificial Analysis Coding Index score | 63.2 |
| `intelligence_index` | *Nullable[float]* | ✅ | Artificial Analysis Intelligence Index score | 71.4 |
26 changes: 13 additions & 13 deletions docs/components/activityitem.mdx
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/components/activityresponse.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ title: "ActivityResponse"

| Field | Type | Required | Description |
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | :heavy_check_mark: | List of activity items |
| `data` | List[[components.ActivityItem](../components/activityitem.mdx)] | ✅ | List of activity items |
8 changes: 4 additions & 4 deletions docs/components/additionaltoolsitem.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Additional tools made available to the model at this point in the input

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A |
| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | :heavy_check_mark: | N/A |
| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | :heavy_check_mark: | N/A |
| `id` | *OptionalNullable[str]* | ➖ | N/A |
| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole.mdx) | ✅ | N/A |
| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion.mdx)] | ✅ | N/A |
| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools.mdx) | ✅ | N/A |
4 changes: 2 additions & 2 deletions docs/components/additionaltoolsitemtool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ title: "AdditionalToolsItemTool"

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