Skip to content

feat(docs): domain migration, branding assets, dead code cleanup#156

Merged
polaz merged 2 commits intomainfrom
fix/155-docs-domain-migration
Jan 23, 2026
Merged

feat(docs): domain migration, branding assets, dead code cleanup#156
polaz merged 2 commits intomainfrom
fix/155-docs-domain-migration

Conversation

@polaz
Copy link
Copy Markdown
Member

@polaz polaz commented Jan 23, 2026 •
edited
Loading

Summary

Cleanup after #155 merge:

  • Remove remaining dead Pages Function code (docs/functions/api/utils.ts, tsconfig.json)
  • Remove orphaned test file (report-bug-utils.test.ts) that tested deleted code
  • Update branding assets (favicon, logo, hero) — regenerated from single high-res source for consistency

Test plan

  • yarn lint — 0 errors
  • yarn build — passes
  • yarn test tests/unit/docs/ — 13 tests pass (handler tests remain)
  • No new functionality — pure cleanup

@polaz
feat(docs): migrate domain, add branding assets, remove dead code
eff2f07 
- Migrate docs domain from docs.gitlab-mcp.sw.foundation to
  gitlab-mcp.sw.foundation across CNAME, Worker, README
- Remove dead CF Pages Function code (docs/functions/) — all API
  logic lives in the CF Worker (docs/worker/)
- Add favicon, OG image (1200x630), regenerate logo from single
  high-res source for consistent branding
- Add head meta tags for link preview (og:image, og:type, og:site_name)
- Fix CI: add needs:deploy to deploy-worker job
- Rewrite tests to target Worker directly instead of deleted Pages Function

Closes #145
Copilot AI review requested due to automatic review settings January 23, 2026 21:45
@polaz polaz enabled auto-merge (squash) January 23, 2026 21:47
@codecov
Copy link
Copy Markdown

codecov bot commented Jan 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@polaz polaz merged commit ce8f18f into main Jan 23, 2026
15 checks passed
@polaz polaz deleted the fix/155-docs-domain-migration branch January 23, 2026 21:49
Copilot AI reviewed Jan 23, 2026
View reviewed changes
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR migrates the documentation site to the new root docs domain, switches the bug-report backend fully over to the Cloudflare Worker, updates branding assets/meta tags, and fixes the docs deployment workflow and tests accordingly.

Changes:

  • Update docs hosting configuration from docs.gitlab-mcp.sw.foundation to gitlab-mcp.sw.foundation (CNAME, Worker routes, CORS config, README links).
  • Remove the old Cloudflare Pages Function implementation for /api/report-bug and retarget unit tests to hit the Cloudflare Worker fetch handler directly.
  • Add favicon/logo/OG assets and <head> meta tags, and ensure the deploy-worker GitHub Actions job correctly depends on the docs deploy job.

Reviewed changes

Copilot reviewed 3 out of 8 changed files in this pull request and generated no comments.

Show a summary per file
File Description
tests/unit/docs/report-bug-utils.test.ts Removes now-obsolete unit tests that targeted the deleted docs/functions/api/utils module.
tests/unit/docs/report-bug-handler.test.ts Rewrites tests to exercise the Cloudflare Worker fetch handler end-to-end, covering routing, CORS, validation, rate limiting, and GitHub API failure/success paths.
docs/worker/wrangler.toml Updates the Worker route pattern to gitlab-mcp.sw.foundation/api/* to match the new docs domain.
docs/worker/src/index.ts Inlines the bug-report API logic into the Worker (validation, CORS, rate limiting, GitHub App auth, ASN.1/PKCS#8 handling) and updates allowed origins for the new domain.
docs/public/CNAME Points the GitHub Pages site to gitlab-mcp.sw.foundation instead of the old subdomain.
docs/functions/tsconfig.json Removes the Pages Functions TypeScript config as the functions/ runtime is no longer used.
docs/functions/api/utils.ts Deletes the shared utils module previously used by the Pages Function; note: this currently breaks the docs widget import (see below).
docs/functions/api/report-bug.ts Removes the Cloudflare Pages Function entrypoint in favor of the Worker-based implementation.
docs/public/logo.png Adds a regenerated logo asset for use as the VitePress site logo.
docs/public/favicon.ico Adds an ICO favicon to support legacy browsers and tab icons.
docs/public/favicon-32x32.png Adds a 32×32 PNG favicon variant.
docs/public/favicon-16x16.png Adds a 16×16 PNG favicon variant.
docs/public/og-image.png Adds the 1200×630 Open Graph image used in social/link previews.
docs/.vitepress/config.mts Registers favicon links and Open Graph meta tags (og:image, og:type, og:site_name) in the docs <head>.
README.md Updates documentation links to the new https://gitlab-mcp.sw.foundation domain.
.github/workflows/docs.yml Ensures the deploy-worker job runs only after the pages deploy job succeeds, aligning Worker deployment with docs updates.

Notable issue (blocking):

  • docs/functions/api/utils.ts is deleted, but docs/.vitepress/theme/components/BugReportWidget.vue still imports CATEGORIES and MIN_DESCRIPTION_LENGTH from that path. This will cause the docs build to fail until those constants are moved to a shared module or the widget import is updated to match the new location (currently only defined inside docs/worker/src/index.ts).
Comments suppressed due to low confidence (1)

docs/functions/api/utils.ts:1

  • Deleting this utils module will break the docs build because BugReportWidget.vue still imports CATEGORIES and MIN_DESCRIPTION_LENGTH from docs/functions/api/utils. Either keep a shared module for these constants (and re-export from the Worker if needed) or move them to a new shared location and update the widget import path to match; otherwise the VitePress docs cannot compile.

sw-release-bot bot pushed a commit that referenced this pull request Jan 23, 2026
@semantic-release-bot
chore(release): 6.34.0 [skip ci]
6e679c7 
## [6.34.0](v6.33.3...v6.34.0) (2026-01-23)

### Features

* **docs:** migrate domain, add branding assets, remove dead code ([#156](#156)) ([ce8f18f](ce8f18f)), closes [#145](#145)
@sw-release-bot
Copy link
Copy Markdown

sw-release-bot bot commented Jan 23, 2026

🎉 This PR is included in version 6.34.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@polaz polaz mentioned this pull request Jan 23, 2026
Closed
polaz added a commit that referenced this pull request Jan 23, 2026
@polaz
fix(docs): inline constants removed with dead code cleanup
043d50d 
BugReportWidget.vue imported CATEGORIES and MIN_DESCRIPTION_LENGTH
from docs/functions/api/utils.ts which was deleted in #156.
Define constants directly in the component.

Fixes #157
@polaz polaz mentioned this pull request Jan 23, 2026
Merged
2 tasks
polaz added a commit that referenced this pull request Jan 23, 2026
@polaz
fix(docs): inline constants removed with dead code cleanup (#158)
c93585f 
BugReportWidget.vue imported CATEGORIES and MIN_DESCRIPTION_LENGTH
from docs/functions/api/utils.ts which was deleted in #156.
Define constants directly in the component.

Fixes #157
@sw-release-bot sw-release-bot bot mentioned this pull request Mar 29, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@polaz