Repository navigation
Conversation
The API docs page reuses the operations console's shell: the sidebar of grouped pages, the header naming the current one, the mobile nav that scrolls sideways, the theme switch and the way back to /dev/null. ConsoleLayout now draws that shell from its props: the brand chip and label, the nav landmark's own label, whether its links prefetch, and a title that falls back to the console's name. OperationsLayout keeps what only operations does (polling, refreshing, the remotes dock) and passes its pages in, with Moderation as an item elsewhere and prefetch off, as before. Nothing changes on screen: captures before and after differ only in the pulsing live dot. Two things only the API docs will use come with it, as part of the shell: links that prefetch, which operations leaves off, and the way back for a guest on a phone, since operations only has signed-in admins.
/docs/api opens the API docs, readable by everyone, on the console layout: the guides in the sidebar, the section named in the header, and the way back to /dev/null. A section the docs don't have is the not found page. This first step brings the page and its Introduction: what the API is for, its base URL and format, and a first request anyone can send. Its code is highlighted on the server and shown in the site's own code blocks. The other guides, the OpenAPI spec and the endpoint reference follow in their own pull requests. The docs are linked as API from the aside, after Apps, and from the user menu where the aside is hidden.
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
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. |
This was referenced Nov 19, 2026
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
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.
Warning
Depends on #1642, still open. Until it merges, this diff also shows its changes; this pull request's own changes.
Summary
The v1 API had no public page. This adds
/docs/api, readable by everyone, on the console shell from #1642, with its first guide: the Introduction. Part of #857 (it documents the v1 API, not/api/cli), and second of five pull requests splitting #1533.Changes
/docs/apiredirects to/docs/api/introduction; a section the docs don't have is the not found page.ApiDocsSectionlists the sections,ApiDocsControllerrenders one with its preview metadata.Accept: application/json, and a first request. Its code is highlighted on the server (ApiGuideSnippets) and shown in the site's code blocks.productionValidation
pest --parallel --coverage --exactly=100.0(full suite)pest --type-coverage --min=100pint --test,rector --dry-run,phpstantscVisual evidence
Playwright (Chromium) against a local dev server on this branch, emulated viewports, Inertia SSR off. The Introduction was captured at 1440×900, 1366×650 and 390×844, light and dark: layout shift (CLS) 0 on load, no horizontal overflow, no console error.
The API link, before and after, in the aside's footer links and in the user menu (captured while this change was part of #1533; the links are unchanged), and a guest's mobile header with its way back to /dev/null.
Device verification
Emulation only (390×844, DPR 2, touch): no hardware or simulator.
Independent review
Fresh read-only reviewers, given the guidelines, the stack, the validation results and the captures. A first round on the previous heads found should-fix points (fixtures and options ahead of their PR, the Errors table hiding its meanings on a phone, the Guilds preview, captures from before production's guild fields), all fixed. Re-review on base
1aa85cf4, head6b4aee82: CODE: PASS, VISUAL: PASS, no blocker or should-fix.Limitations
The sidebar lists the Introduction alone until #1644.