Skip to content

docs: remove CI sub-routes - #685

Merged
AbhishekDoshi26 merged 2 commits into
mainfrom
docs/remove-ci-subroutes
Sep 23, 2026
Merged

AbhishekDoshi26 merged 2 commits into
mainfrom
docs/remove-ci-subroutes

Conversation

@AbhishekDoshi26

@AbhishekDoshi26 AbhishekDoshi26 commented Sep 23, 2026 •

Copy link
Copy Markdown
Member

Summary

Shorebird CI was deprecated on August 8, 2026. The docs already reflect the deprecation notice, but the sidebar still exposed multiple sub-routes (setup, view-logs, uninstall, faq, and the entire checks section) that served no purpose beyond showing the deprecation callout.

Changes

  • Removed all CI sub-pages: setup, faq, uninstall, view-logs, and the checks/ subdirectory (6 pages plus its _meta.yml), 11 files in total
  • Updated ci/index.mdx to serve as the single CI page: title is now Shorebird CI, the description carries the deprecation date and points at migration options, and the sidebar frontmatter is removed since it no longer applies to a link item
  • Updated sidebar in astro.config.mjs: CI is now a single link item labeled CI instead of an auto-generated collapsible group (deprecated badge preserved)
  • Added redirects in astro.config.mjs for all 10 removed sub-routes → /ci/ to preserve any existing links/bookmarks (one key per route; the generated index.html also serves the trailing-slash form)

@AbhishekDoshi26 AbhishekDoshi26 left a comment

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review notes (addressed in a follow-up commit on this branch):

Redirect keys collide on trailing slash (astro.config.mjs). Each removed route was listed as both /ci/x and /ci/x/. Astro treats those as the same static route and warns for all 10 pairs:

[WARN] [router] The route "/ci/checks/analyze" is defined in both "/ci/checks/analyze" and "/ci/checks/analyze/". A static route cannot be defined more than once.
[WARN] [router] A collision will result in a hard error in following versions of Astro.

The bare key alone generates dist/ci/x/index.html, which already serves /ci/x/, so the slash variants are redundant. Kept only the bare keys, matching most existing entries.

Minor

  • ci/index.mdx: sidebar.label / sidebar.order no longer apply now that CI is a plain link: sidebar item. Removed.
  • Title CI rendered as a bare # CI in the page H1 and llms-full.txt. Changed to Shorebird CI (the sidebar label stays CI, since it comes from astro.config.mjs).
  • Description duplicated the callout title. Replaced with one that carries the date and points at migration options.

Verified with a local build: no route collision warnings for /ci/*, all 10 removed routes emit a meta-refresh redirect to /ci/, the sitemap lists only /ci/, and nothing else in the repo links to the removed routes.

Drop trailing-slash redirect keys that collide with the bare keys in Astro's router, remove sidebar frontmatter that no longer applies to a link item, and retitle the page to Shorebird CI.
@AbhishekDoshi26
AbhishekDoshi26 merged commit 9d85fef into main Sep 23, 2026
4 checks passed
@AbhishekDoshi26
AbhishekDoshi26 deleted the docs/remove-ci-subroutes branch September 23, 2026 10:36
AbhishekDoshi26 added a commit that referenced this pull request Sep 23, 2026
…on-server (#686)

_shorebird#3031 merged on 2026-09-11 and auth.shorebird.dev now serves
real RFC 8414 metadata: issuer, /login, /token, PKCE, the actual
scopes (admin, preview_read, zap_preview_publish). Verified live
before touching anything.

Added an accurate pointer to it in auth.md's Protected resources
section and restored the oauth-authorization-server Link header rel,
both pointing at auth.shorebird.dev, not a copy on this domain.

Deliberately not republishing a copy at
docs.shorebird.dev/.well-known/oauth-authorization-server, even though
isitagentready.com's oauth-discovery check only looks at the scanned
domain's own well-known paths and wouldn't pass otherwise: that is
exactly the mistake _shorebird's own review caught and #659 removed
from this repo. RFC 8414 resolves the well-known path from the
issuer, so a copy here would not be found by standards-based discovery
and would silently drift if the real document ever changes. Chose not
to re-add the mistake for one check's score.

oauth-protected-resource (_shorebird#3043) is still open/unmerged and
404s on api.shorebird.dev, so left untouched. Confirmed no stale scope
names (apps:read etc, deleted in #659) remain anywhere in this repo.

Also confirmed the real shorebird_mcp_server now exists and is live at
mcp.shorebird.dev/mcp (401 on an unauthenticated request, matching its
RFC 9728 design), but it backs Shorebird Zap, a prototype documented
only on a deliberately unlisted page (src/unlisted.ts) for a limited
beta. Not publishing an MCP Server Card for it: that would publicly
advertise a capability the product side has deliberately kept out of
the sitemap, llms.txt, and search indexes.

Cleaned up 6 pre-existing em-dashes in functions/_middleware.ts and
one in auth.md while in both files.

Verified via wrangler pages dev: the new Link header and auth.md
content, and the full existing negotiation scenario suite, against a
currently-live page (the earlier /ci/view-logs/ test target from prior
sessions was removed in #685 since Shorebird CI is deprecated).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant