feat(nav): add Python entry under Generated API Reference#21
Merged
WomB0ComB0 merged 1 commit intomainfrom May 9, 2026
Merged
Conversation
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
area:content
4 tasks
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request migrates the .NET SDK API documentation from .md to .mdx format and adds a Python SDK section to the documentation configuration. The review feedback highlights several missed link updates where internal references still point to .md files instead of the new .mdx versions, which needs to be corrected to prevent broken links in the generated documentation.
This was referenced May 9, 2026
WomB0ComB0
pushed a commit
that referenced
this pull request
May 9, 2026
Mintlify's broken-links resolver rejects explicit `.mdx` in in-content link targets — it treats those as static-asset references rather than page references and reports them as broken. Extensionless links resolve correctly (Mintlify finds the matching .md or .mdx in the tree). Change the rename step's link-target rewrite from `(path.md)` -> `(path.mdx)` to `(path.md)` -> `(path)` The file rename .md -> .mdx still happens; only the link form in content changes. Same regex anchor (skip http://, mailto:, /, #); just a different replacement. Mirrors the on-disk fix that just landed on #21 (commit 7301dbc, 3186 files).
WomB0ComB0
pushed a commit
that referenced
this pull request
May 9, 2026
Previous approach (commits 229acac, 84cbf4e on origin) renamed every .md in the auto-generated tree to .mdx and rewrote in-content link targets. The wholesale rename tripped Mintlify's broken-links validation with 3832 broken-link errors because Mintlify rejects explicit `.mdx` extensions in in-content links (treats them as static-asset references rather than page references). The previous attempt to fix the link form (strip .md from targets, leave them extensionless) didn't help either: Mintlify's broken-links also requires nav registration for any non-.md link. Scope the rename to ONLY the three files Mintlify's nav resolver actually looks for: - TypeScript: add a tiny `mv README.md README.mdx` step at the end (typedoc-plugin-markdown emits the README itself, so we rename the result rather than redirecting the generator). - .NET: change the `Write top-level index` step's redirect target from `README.md` to `README.mdx`. - Python: same as .NET. Submodule pages stay .md. Mintlify treats their `(path.md)` in-content links as page references and resolves them on disk regardless of extension, so they continue to render correctly. Pairs with #21 (one-shot rename of the same three READMEs in the existing tree).
WomB0ComB0
force-pushed
the
feat/sdk-api-nav-and-mdx
branch
from
7301dbc to
54934ef
Compare
This was referenced May 9, 2026
Single-line nav addition — points at sdks/python/api/README which Mintlify resolves via the existing .md file. No file renames; the auto-generated trees stay as .md because Mintlify's .md link resolver is filesystem-based and already accepts the cross-references TypeDoc / DefaultDocumentation / pydoc-markdown emit. Renaming the READMEs to .mdx (attempted in earlier commits 4e31133 / 7301dbc / 54934ef) was the wrong move — .mdx parents have stricter link resolution that requires every link target to be nav-registered, which is not feasible for 3500+ auto-generated pages. The "is referenced in docs.json navigation but the file does not exist" warning that mint dev emits for .md-extension README references is cosmetic; Mintlify still renders the page. The "Generated API Reference" group from PR #17 only had TypeScript and .NET sub-groups; PR #18 (Python template) and the resulting auto-PRs (#19, #20) landed the Python content after that PR was opened.
WomB0ComB0
force-pushed
the
feat/sdk-api-nav-and-mdx
branch
from
54934ef to
bdea2d4
Compare
WomB0ComB0
added a commit
to resq-software/npm
that referenced
this pull request
May 9, 2026
Diagnosed via resq-software/docs#21: Mintlify's .mdx parent files have stricter link resolution than .md parents (require nav registration for every link target), and the wholesale rename tripped 3832 broken-link errors. Reverting to the pre-rename template — the auto-generated trees stay as .md and Mintlify resolves them filesystem-style. The mint dev warning about top-level README is cosmetic.
WomB0ComB0
added a commit
to resq-software/dotnet-sdk
that referenced
this pull request
May 9, 2026
Diagnosed via resq-software/docs#21: Mintlify's .mdx parent files have stricter link resolution than .md parents (require nav registration for every link target), and the wholesale rename tripped 3832 broken-link errors. Reverting to the pre-rename template — the auto-generated trees stay as .md and Mintlify resolves them filesystem-style. The mint dev warning about top-level README is cosmetic.
WomB0ComB0
changed the title
WomB0ComB0
added a commit
to resq-software/npm
that referenced
this pull request
May 9, 2026
* fix(ci): scope README rename to top-level only (sync from docs#22) The wholesale .md -> .mdx rename + link rewrite step (added in ci/api-docs-emit-mdx) tripped Mintlify's broken-links validation with 3832 errors on the docs repo: Mintlify rejects explicit .mdx in in-content links (treats as static-asset references) and also rejects extensionless links to non-nav-registered pages. Scope the rename to ONLY the nav-registered top-level README. Submodule pages stay .md and continue resolving via in-content links. * fix(ci): drop wholesale .md -> .mdx rename step Diagnosed via resq-software/docs#21: Mintlify's .mdx parent files have stricter link resolution than .md parents (require nav registration for every link target), and the wholesale rename tripped 3832 broken-link errors. Reverting to the pre-rename template — the auto-generated trees stay as .md and Mintlify resolves them filesystem-style. The mint dev warning about top-level README is cosmetic.
WomB0ComB0
added a commit
to resq-software/dotnet-sdk
that referenced
this pull request
May 9, 2026
* fix(ci): scope README rename to top-level only (sync from docs#22) The wholesale .md -> .mdx rename + link rewrite step (added in ci/api-docs-emit-mdx) tripped Mintlify's broken-links validation with 3832 errors on the docs repo: Mintlify rejects explicit .mdx in in-content links (treats as static-asset references) and also rejects extensionless links to non-nav-registered pages. Scope the rename to ONLY the nav-registered top-level README. Submodule pages stay .md and continue resolving via in-content links. * fix(ci): drop wholesale .md -> .mdx rename step Diagnosed via resq-software/docs#21: Mintlify's .mdx parent files have stricter link resolution than .md parents (require nav registration for every link target), and the wholesale rename tripped 3832 broken-link errors. Reverting to the pre-rename template — the auto-generated trees stay as .md and Mintlify resolves them filesystem-style. The mint dev warning about top-level README is cosmetic.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a Python sub-group under the SDKs > Generated API Reference group, pointing at
sdks/python/api/README. PR #17 added TypeScript and .NET; Python landed via PRs #18-20 after that PR was opened.Scope (final)
One line. Just the nav addition:
Why not more
Earlier iterations on this branch tried to silence the
mint devwarning:via wholesale
.md → .mdxrename of the auto-generated trees. That was the wrong fix — Mintlify's.mdxparent files have stricter link resolution than.mdparents (every link target must be nav-registered or a static asset), and the auto-generated trees can't satisfy that for 3500+ pages. Result: 3832 broken-link errors.The warning is cosmetic. Mintlify still renders the
.mdREADME pages correctly. Confirmed via this PR's now-passingmintlify (broken links)check.Out of scope follow-ups
/sdks/python/api/mcpwas a typo'd URL (the actual page is/sdks/python/api/resq-mcp/overview). Adding Python to nav makes the README discoverable; users navigate to per-package overviews from there.