Skip to content

fix(nav): include docs.json in auto-PR add-paths #38

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
WomB0ComB0 merged 1 commit into from
May 9, 2026
Merged

fix(nav): include docs.json in auto-PR add-paths #38

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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion automation/source-repo-templates/api-docs.dotnet.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,9 @@ jobs:
branch: auto/dotnet-api-${{ env.DOCS_REF_SLUG }}
base: main
delete-branch: true
add-paths: sdks/dotnet/api/**
add-paths: |
sdks/dotnet/api/**
docs.json
labels: |
automated
docs:api-ref
Expand Down
4 changes: 3 additions & 1 deletion automation/source-repo-templates/api-docs.python.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -475,7 +475,9 @@ jobs:
branch: auto/python-api-${{ env.DOCS_REF_SLUG }}
base: main
delete-branch: true
add-paths: sdks/python/api/**
add-paths: |
sdks/python/api/**
docs.json
Comment on lines +478 to +480
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The navigation splicing logic (lines 393-456) currently produces duplicated entries in docs.json for modules that contain submodules (e.g., core appearing both as a page and a group). Consider updating the to_mintlify function to detect these collisions and place the module-level page as the first item inside its corresponding group using the nested group object structure required by the Mintlify schema.

References
  1. In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.

labels: |
automated
docs:api-ref
Expand Down
4 changes: 3 additions & 1 deletion automation/source-repo-templates/api-docs.typescript.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -355,7 +355,9 @@ jobs:
branch: auto/typescript-api-${{ github.ref_name }}
base: main
delete-branch: true
add-paths: sdks/typescript/api/**
add-paths: |
sdks/typescript/api/**
docs.json
Comment on lines +358 to +360
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The navigation splicing logic (lines 260-332) results in duplicated sidebar entries for components that have nested groups. It is recommended to refine the tree construction logic to merge component-level pages into their respective groups using nested group objects to avoid a cluttered navigation menu and adhere to the Mintlify schema.

References
  1. In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.

labels: |
automated
docs:api-ref
Expand Down
61 changes: 59 additions & 2 deletions docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5214,13 +5214,70 @@
{
"group": "resq-dsa",
"pages": [
"sdks/python/api/resq-dsa/overview"
"sdks/python/api/resq-dsa/bloom",
"sdks/python/api/resq-dsa/count_min",
"sdks/python/api/resq-dsa/graph",
"sdks/python/api/resq-dsa/heap",
"sdks/python/api/resq-dsa/overview",
"sdks/python/api/resq-dsa/trie"
Comment on lines +5217 to +5222
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The overview page should be the first item in the navigation group for better discoverability. Since docs.json is auto-generated by the build workflow, this ordering should be enforced in the generator logic rather than manually edited here to prevent the changes from being overwritten.

References
  1. Do not manually add entries to documentation configuration files if they are automatically populated by a build workflow, as manual entries can cause errors and will be overwritten.

]
},
{
"group": "resq-mcp",
"pages": [
"sdks/python/api/resq-mcp/overview"
"sdks/python/api/resq-mcp/core",
"sdks/python/api/resq-mcp/drone",
"sdks/python/api/resq-mcp/dtsop",
"sdks/python/api/resq-mcp/hce",
"sdks/python/api/resq-mcp/models",
"sdks/python/api/resq-mcp/overview",
"sdks/python/api/resq-mcp/pdie",
"sdks/python/api/resq-mcp/prompts",
"sdks/python/api/resq-mcp/resources",
"sdks/python/api/resq-mcp/server",
"sdks/python/api/resq-mcp/telemetry",
"sdks/python/api/resq-mcp/tools",
{
"group": "core",
"pages": [
"sdks/python/api/resq-mcp/core/config",
"sdks/python/api/resq-mcp/core/errors",
"sdks/python/api/resq-mcp/core/models",
"sdks/python/api/resq-mcp/core/security",
"sdks/python/api/resq-mcp/core/telemetry",
"sdks/python/api/resq-mcp/core/timeout"
]
},
{
"group": "drone",
"pages": [
"sdks/python/api/resq-mcp/drone/models",
"sdks/python/api/resq-mcp/drone/service"
]
},
{
"group": "dtsop",
"pages": [
"sdks/python/api/resq-mcp/dtsop/models",
"sdks/python/api/resq-mcp/dtsop/service",
"sdks/python/api/resq-mcp/dtsop/tools"
]
},
{
"group": "hce",
"pages": [
"sdks/python/api/resq-mcp/hce/models",
"sdks/python/api/resq-mcp/hce/service",
"sdks/python/api/resq-mcp/hce/tools"
]
},
{
"group": "pdie",
"pages": [
"sdks/python/api/resq-mcp/pdie/models",
"sdks/python/api/resq-mcp/pdie/service"
]
}
]
Comment on lines +5228 to 5281
Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist Bot May 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The resq-mcp navigation contains redundant entries where submodules (like core, drone, dtsop, hce, and pdie) are listed both as top-level pages and as group titles. Use a nested group object (e.g., group: Label, pages: [path]) to define these in the navigation configuration. This structure avoids duplication and adheres to the Mintlify schema. Ensure this logic is updated in the generator templates to prevent manual changes from being overwritten.

References
  1. In Mintlify docs.json navigation configuration, use a nested group object to define custom sidebar labels for pages, as the schema does not support a label property within the pages array.
  2. Do not manually add entries to documentation configuration files if they are automatically populated by a build workflow, as manual entries can cause errors and will be overwritten.

}
]
Expand Down
Loading