Add the API hub landing page - #3404
Merged
Merged
Conversation
ellen-octopus
marked this pull request as ready for review
August 20, 2026 07:29
ellen-octopus
marked this pull request as draft
August 20, 2026 07:41
ellen-octopus
marked this pull request as ready for review
August 20, 2026 08:37
ellen-octopus
marked this pull request as draft
August 20, 2026 08:37
|
Pull request environment is available at https://stoctodocspr3404.z22.web.core.windows.net. You can view the ephemeral environment status in Octopus Deploy. This environment will be automatically deprovisioned when the pull request is closed, or after 7 days of inactivity. |
Introduces /docs/api as a hub page linking to common endpoints, client libraries, and community resources, distinct from the generated per-endpoint reference pages. Api.astro and the API stylesheets gain support for this hub layout (no breadcrumbs/feedback widget, its own content width). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> # Conflicts: # src/layouts/Api.astro
The API hub page's navTitle ("Get started", used for its left-nav
label) was being reused as its breadcrumb crumb on every child page.
Give it a distinct crumbTitle and drop the now-redundant sectionCrumb
splice, since the hub page is a real route the breadcrumb walk finds
on its own.
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
borland
force-pushed
the
ellen/api-hubpage
branch
from
August 21, 2026 05:32
790209b to
59d203f
Compare
borland
marked this pull request as ready for review
August 21, 2026 05:33
borland
approved these changes
Aug 21, 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
3 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.
Update from Orion: I rebased the PR, which picked up changes from main and rendered the below test/areas/layout changes redundant. I rolled them back and incorporated the design so we can merge it.
I removed the "Create API key" button because it didn't render properly with the layout updates, it looked weird. Easy to add later when things settle down
Changes to these pages are entirely Claude-driven, and were made in an attempt to make the checks pass validation. I suspect it's not very accurate:
Claude generated summary:
Summary
/docs/apias a hub landing page linking to common endpoints, API client libraries, and community resourcesApi.astroand the API stylesheets to support this hub layout (no breadcrumbs/feedback widget, its own content width) separate from the generated per-endpoint reference pagesnavTitle: Get started(its left-nav label) was leaking into the breadcrumb trail on every API endpoint page, e.g.Docs > Get started > Accountsinstead ofDocs > API > Accounts.crumbTitle: APIto the hub page's frontmatter, and removed the now-redundantsectionCrumbsplice inareas.ts— that was a workaround from before the hub page existed as a real route.tests/api-page.spec.ts, which still pinned pre-hub-page behavior:'Api'→ now a linked'API'crumb/docs/api/expected to 404 → now 200 (it's the hub page)/docs/api/indexexpected to 404 → now 200 (the built site serves clean URLs, so it resolves to the same file as/docs/api/)See the new page here
Screenshot:
