Improve API Explorer examples rail and Nav V2 sidebar - #3796
Open
itsalexcm wants to merge 10 commits into
Open
Conversation
Wire API pages into the global sidebar (x-tagGroups, active highlighting), generate OpenAPI output in the assembler, and use HTMX partial swaps so API navigation stays smooth without full-page reloads. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
API pages stay on isolated serve (/api/...) until we revisit integrating them into the full assembler output at /docs/api/. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Group OpenAPI request/response examples into a right-hand rail, pair request variants in a select, and share unmatched error responses as status-code tabs so Kibana-style multi-status samples stay usable. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Match request/response chrome to Card/Code, keep language selection in a compact select, and add a non-selectable line gutter so long samples stay readable without polluting copy/selection. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Keep author-facing docs aligned with request-variant grouping, shared status-code tabs, and JSON vs plaintext highlighting rules. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
The [with(...)] collection expression form fails to compile in this toolchain; use new Dictionary/HashSet constructors instead. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Keep an empty examples rail slot on markdown layouts so leaving API pages clears the panel, and update link oob targets/tests to match. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Show all operation path overloads as a vertical list again so each route is visible without a dropdown. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Extract folder rows, match heading/item spacing and padding, and paint the active blue accent only on nested items above the gray rail. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
Restore [with(comparer)] collection expressions rejected as IDE0028, and apply Prettier/import formatting for the API Site assets and tests. Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com> Co-authored-by: Cursor <cursoragent@cursor.com>
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
1 participant
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.
Why
API reference pages need a clearer examples experience and a sidebar that matches the Nav V2 / Figma patterns used elsewhere, without burying alternate paths behind a dropdown.
What
Adds a Scalar-style examples rail with scenario grouping and response tabs, integrates ApiExplorer with Nav V2 sidebar chrome, restores stacked path overloads, and aligns nested active/open nav styles (padding, gap, blue accent) with the Figma sidebar. Also keeps
#api-examples-panelin HTMX OOB swaps so the rail clears when leaving API pages.Made with Cursor