docs: add models api page and cap sidebar width#20
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![mogplex[bot]](https://avatars.githubusercontent.com/in/3107927?s=60&v=4){kind=small}
There was a problem hiding this comment.
Mogplex PR Review
Status: Attention needed
Pure documentation PR that adds a first-class Models API page, wires up cross-links across the web API docs, and relaxes the desktop sidebar width. No security, correctness, or architectural issues. Two minor documentation accuracy items worth addressing before merge.
2 findings were added inline.
There was a problem hiding this comment.
Mogplex PR Review
Status: Attention needed
Documentation-only PR plus a minor CSS flex-width change. The overall quality is high — the new Models page is well-structured, cross-linking is consistent, and the min(270px, 35vw) CSS change behaves correctly. Two documentation clarity issues are worth fixing before this ships: an internally contradictory sentence in the CLI-format section, and a missing description of the unauthenticated response shape (the only example shown is for authenticated callers).
2 findings were added inline.
There was a problem hiding this comment.
Mogplex PR Review
Status: Attention needed
A clean docs + CSS PR. The new Models page is accurate, well-organized, and cross-linked correctly across four other files. One minor behavioral edge case in the CSS change and one small documentation inconsistency are worth a look, but neither blocks the merge.
2 findings were added inline.
| #nd-docs-layout { | ||
| /* Fumadocs switches from drawer to full sidebar at 768px. */ | ||
| --fd-sidebar-width: 270px; | ||
| /* Fumadocs switches from drawer to full sidebar at 768px; prefer the normal 270px width and only shrink slightly on the narrowest desktop viewports. */ |
There was a problem hiding this comment.
Suggestion: Sidebar width at 768px breakpoint entry is 1–2px narrower than the previous fixed value
At exactly 768px viewport width (the min-width breakpoint), 35vw evaluates to ~268.8px — slightly less than the prior fixed 270px. The intent described in the PR is to cap at 270px and allow shrinking on narrow desktops, but the practical floor kicks in at the breakpoint itself, producing a marginally narrower sidebar on the narrowest desktop viewport.
If the goal is "never wider than 270px, never narrower than X on desktop", consider clamp(240px, 35vw, 270px) or simply keeping max-width: 270px in addition to the variable. If the ~1px difference is intentional, a brief comment to that effect would help future readers.
| "provider": "provider", | ||
| "name": "Model B", | ||
| "is_available": true, | ||
| "is_enabled": false |
There was a problem hiding this comment.
Suggestion: Unauthenticated response shape omits is_enabled without explanation
The authenticated catalog entry for model-a includes "is_enabled": true, but the unauthenticated excerpt for the same model omits is_enabled entirely. The prose says "without user auth, both catalog and models are the same visible available catalog" but does not call out that is_enabled is absent from unauthenticated responses.
Adding one sentence like "Unauthenticated responses omit is_enabled since there is no user context to evaluate preferences against" would pre-empt a common reader question.
1 participant
Summary
Verification