Skip to content

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

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 #562

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
  •  
  •  
  •  
10 changes: 7 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,8 +8,9 @@ on:
workflow_dispatch:
pull_request:
paths:
- "docs/sdks/**"
- "docs/**"
- "scripts/gen-docs-nav.sh"
- "scripts/fix-docs-links.sh"
- ".github/workflows/docs-nav.yaml"

jobs:
Expand All @@ -26,7 +27,10 @@ jobs:
- name: Regenerate docs navigation
run: scripts/gen-docs-nav.sh

- name: Auto-commit docs.json navigation
- 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"
commit-message: "Chore: regenerate docs navigation and fix docs links"
2 changes: 1 addition & 1 deletion docs/components/actionfindinpage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ title: "ActionFindInPage"
| Field | Type | Required | Description |
| ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| `pattern` | *str* | :heavy_check_mark: | N/A |
| `type` | [components.TypeFindInPage](../components/typefindinpage.mdx) | :heavy_check_mark: | N/A |
| `type` | [components.TypeFindInPage](../components/typefindinpage) | :heavy_check_mark: | N/A |
| `url` | *str* | :heavy_check_mark: | N/A |
2 changes: 1 addition & 1 deletion docs/components/actionopenpage.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ title: "ActionOpenPage"

| Field | Type | Required | Description |
| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
| `type` | [components.TypeOpenPage](../components/typeopenpage.mdx) | :heavy_check_mark: | N/A |
| `type` | [components.TypeOpenPage](../components/typeopenpage) | :heavy_check_mark: | N/A |
| `url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A |
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)] | :heavy_check_mark: | List of activity items |
6 changes: 3 additions & 3 deletions docs/components/additionaltoolsitem.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,6 @@ 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 |
| `role` | [components.AdditionalToolsItemRole](../components/additionaltoolsitemrole) | :heavy_check_mark: | N/A |
| `tools` | List[[components.AdditionalToolsItemToolUnion](../components/additionaltoolsitemtoolunion)] | :heavy_check_mark: | N/A |
| `type` | [components.TypeAdditionalTools](../components/typeadditionaltools) | :heavy_check_mark: | N/A |
2 changes: 1 addition & 1 deletion docs/components/additionaltoolsitemtoolfunction.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ Function tool definition
| `name` | *str* | :heavy_check_mark: | N/A |
| `parameters` | Dict[str, *Any*] | :heavy_check_mark: | N/A |
| `strict` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A |
| `type` | [components.AdditionalToolsItemTypeFunction](../components/additionaltoolsitemtypefunction.mdx) | :heavy_check_mark: | N/A |
| `type` | [components.AdditionalToolsItemTypeFunction](../components/additionaltoolsitemtypefunction) | :heavy_check_mark: | N/A |
2 changes: 1 addition & 1 deletion docs/components/advisorreasoning.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Reasoning configuration forwarded to the advisor call. Use this to control reaso

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