Skip to content

fix(docs): strip .mdx extensions from generated docs links #718

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

Draft
devin-ai-integration wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

fix(docs): strip .mdx extensions from generated docs links #718

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
  •  
  •  
  •  
36 changes: 36 additions & 0 deletions .github/workflows/docs-nav.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Docs navigation

permissions:
contents: write
pull-requests: write

on:
workflow_dispatch:
pull_request:
paths:
- "docs/**"
- "scripts/gen-docs-nav.sh"
- "scripts/fix-docs-links.sh"
- ".github/workflows/docs-nav.yaml"

jobs:
gen-docs-nav:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v5
with:
ref: ${{ github.event.pull_request.head.ref }}
token: ${{ secrets.GITHUB_TOKEN }}

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

- name: Strip .mdx extensions from docs links
run: scripts/fix-docs-links.sh

- name: Auto-commit docs post-processing
uses: int128/update-generated-files-action@v2
with:
commit-message: "Chore: regenerate docs navigation and fix docs links"
3 changes: 3 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 @@ -47,6 +47,9 @@ jobs:
- name: Regenerate docs navigation
run: scripts/gen-docs-nav.sh

- name: Strip .mdx extensions from docs links
run: scripts/fix-docs-links.sh

- name: Validate SDK
uses: ./.github/actions/validate-sdk
with:
Expand Down
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 @@ -30,4 +30,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)[] | :heavy_check_mark: | List of activity items |
4 changes: 2 additions & 2 deletions docs/models/additionaltoolsitem.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,6 @@ 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 |
| `role` | [models.AdditionalToolsItemRole](../models/additionaltoolsitemrole) | :heavy_check_mark: | N/A |
| `tools` | *models.AdditionalToolsItemToolUnion*[] | :heavy_check_mark: | N/A |
| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools.mdx) | :heavy_check_mark: | N/A |
| `type` | [models.TypeAdditionalTools](../models/typeadditionaltools) | :heavy_check_mark: | N/A |
2 changes: 1 addition & 1 deletion docs/models/additionaltoolsitemtoolfunction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,4 @@ let value: AdditionalToolsItemToolFunction = {
| `name` | *string* | :heavy_check_mark: | N/A |
| `parameters` | Record\<string, *any*> | :heavy_check_mark: | N/A |
| `strict` | *boolean* | :heavy_minus_sign: | N/A |
| `type` | [models.AdditionalToolsItemTypeFunction](../models/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A |
| `type` | [models.AdditionalToolsItemTypeFunction](../models/additionaltoolsitemtypefunction) | :heavy_check_mark: | N/A |
2 changes: 1 addition & 1 deletion docs/models/advisorreasoning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,5 @@ let value: AdvisorReasoning = {};

| Field | Type | Required | Description |
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `effort` | [models.AdvisorReasoningEffort](../models/advisorreasoningeffort.mdx) | :heavy_minus_sign: | Reasoning effort level for the advisor call. |
| `effort` | [models.AdvisorReasoningEffort](../models/advisorreasoningeffort) | :heavy_minus_sign: | Reasoning effort level for the advisor call. |
| `maxTokens` | *number* | :heavy_minus_sign: | Maximum number of reasoning tokens the advisor may use. |
Loading
Loading