Skip to content

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

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 6 commits into from
Oct 6, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
756ed45
fix(docs): sanitize generated emoji shortcodes
devin-ai-integration[bot] Oct 6, 2026
f7b4a68
fix(docs): ignore URN-style colons in residual shortcode guard
devin-ai-integration[bot] Oct 6, 2026
08655a5
chore(docs): sanitize generated emoji shortcodes
devin-ai-integration[bot] Oct 6, 2026
ca54649
ci(docs): skip auto-commit on manual workflow_dispatch
devin-ai-integration[bot] Oct 6, 2026
d3de8c1
fix(docs): make residual shortcode guard portable and fail on scan er…
devin-ai-integration[bot] Oct 6, 2026
2a24ccb
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
  •  
  •  
  •  
19 changes: 16 additions & 3 deletions .github/workflows/docs-nav.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,17 @@ on:
workflow_dispatch:
Comment thread
devin-ai-integration[bot] marked this conversation as resolved.
pull_request:
paths:
- "docs/sdks/**"
- "docs/**"
- "scripts/sanitize-docs-emoji.sh"
- "scripts/gen-docs-nav.sh"
- ".github/workflows/docs-nav.yaml"

# Shared with speakeasy_run_on_pr.yaml: both push generated files to the PR
# head branch, so they must not run at the same time on the same PR.
concurrency:
group: generated-files-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: false

jobs:
gen-docs-nav:
runs-on: ubuntu-latest
Expand All @@ -22,11 +29,17 @@ jobs:
ref: ${{ github.event.pull_request.head.ref }}
token: ${{ secrets.GITHUB_TOKEN }}

- name: Sanitize generated docs emoji
run: scripts/sanitize-docs-emoji.sh

# jq is preinstalled on GitHub-hosted ubuntu runners.
- name: Regenerate docs navigation
run: scripts/gen-docs-nav.sh

Comment thread
devin-ai-integration[bot] marked this conversation as resolved.
- name: Auto-commit docs.json navigation
# On manual dispatch there is no PR head ref, so checkout falls back to
# main; never auto-commit there.
- name: Auto-commit generated docs files
if: github.event_name == 'pull_request'
uses: int128/update-generated-files-action@v2
with:
Comment thread
devin-ai-integration[bot] marked this conversation as resolved.
commit-message: "Chore: regenerate docs navigation"
commit-message: "Chore: sanitize generated docs emoji"
9 changes: 9 additions & 0 deletions .github/workflows/speakeasy_run_on_pr.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ on:
paths:
- .speakeasy/in.openapi.yaml

# Shared with docs-nav.yaml: both push generated files to the PR head branch,
# so they must not run at the same time on the same PR.
concurrency:
group: generated-files-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: false

jobs:
run-speakeasy:
runs-on: ubuntu-latest
Expand Down Expand Up @@ -44,6 +50,9 @@ jobs:
env:
SPEAKEASY_API_KEY: ${{ secrets.SPEAKEASY_API_KEY }}

- 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/models/aabenchmarkentry.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ let value: AABenchmarkEntry = {

| Field | Type | Required | Description | Example |
| -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- |
| `agenticIndex` | *number* | :heavy_check_mark: | Artificial Analysis Agentic Index score | 55.8 |
| `codingIndex` | *number* | :heavy_check_mark: | Artificial Analysis Coding Index score | 63.2 |
| `intelligenceIndex` | *number* | :heavy_check_mark: | Artificial Analysis Intelligence Index score | 71.4 |
| `agenticIndex` | *number* | ✅ | Artificial Analysis Agentic Index score | 55.8 |
| `codingIndex` | *number* | ✅ | Artificial Analysis Coding Index score | 63.2 |
| `intelligenceIndex` | *number* | ✅ | Artificial Analysis Intelligence Index score | 71.4 |
26 changes: 13 additions & 13 deletions docs/models/activityitem.mdx
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/models/activityresponse.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ let value: ActivityResponse = {

| Field | Type | Required | Description |
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
| `data` | [models.ActivityItem](../models/activityitem.mdx)[] | :heavy_check_mark: | List of activity items |
| `data` | [models.ActivityItem](../models/activityitem.mdx)[] | ✅ | List of activity items |
8 changes: 4 additions & 4 deletions docs/models/additionaltoolsitem.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ let value: AdditionalToolsItem = {

| Field | Type | Required | Description |
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| `id` | *string* | :heavy_minus_sign: | N/A |
| `role` | [models.AdditionalToolsItemRole](../models/additionaltoolsitemrole.mdx) | :heavy_check_mark: | N/A |
| `tools` | *models.AdditionalToolsItemToolUnion*[] | :heavy_check_mark: | N/A |
| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools.mdx) | :heavy_check_mark: | N/A |
| `id` | *string* | ➖ | N/A |
| `role` | [models.AdditionalToolsItemRole](../models/additionaltoolsitemrole.mdx) | ✅ | N/A |
| `tools` | *models.AdditionalToolsItemToolUnion*[] | ✅ | N/A |
| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools.mdx) | ✅ | N/A |
4 changes: 2 additions & 2 deletions docs/models/additionaltoolsitemtool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ let value: AdditionalToolsItemTool = {

| Field | Type | Required | Description |
| ---------------------- | ---------------------- | ---------------------- | ---------------------- |
| `type` | *string* | :heavy_check_mark: | N/A |
| `additionalProperties` | Record\<string, *any*> | :heavy_minus_sign: | N/A |
| `type` | *string* | ✅ | N/A |
| `additionalProperties` | Record\<string, *any*> | ➖ | N/A |
Loading
Loading