Skip to content

refactor: migrate docs to docs-kit and replace concurrently with mprocs#106

Merged
jaysin586 merged 5 commits into
mainfrom
feature-udpated-version
Mar 5, 2026
Merged

refactor: migrate docs to docs-kit and replace concurrently with mprocs#106
jaysin586 merged 5 commits into
mainfrom
feature-udpated-version

Conversation

@jaysin586

Copy link
Copy Markdown
Contributor

Summary

Migrates the docs site to the shared @humanspeak/docs-kit library, replaces concurrently with mprocs for the dev workflow, and adds Content Security Policy headers.

Changes

🔧 Refactoring

  • Migrate docs site to @humanspeak/docs-kit — replaces local Sidebar, Breadcrumb, SEO, Header, and Footer components
  • Add centralized docsConfig and docsNav configuration
  • Switch Lucide icons from barrel imports to tree-shakeable deep imports
  • Use docsConfig.description as single source of truth for social card generation

New features

  • Add social card generation (generate-social-cards.ts) and GitHub stats fetching (fetch-github-stats.ts)
  • Add Content Security Policy directives to docs site
  • Add cf-typegen root script for Cloudflare worker types

📦 Build & tooling

  • Replace concurrently with mprocs for dev:all workflow
  • Add mprocs.yaml with procs for urls, pkg, docs, sitemap, and social
  • Add scripts/dev-urls.mjs for dev server port discovery
  • Set tsconfigRootDir in root and docs ESLint configs to fix monorepo parsing errors
  • Update trunk plugins and linter versions
  • Bump dependency versions

🔒 Other

  • Update LICENSE copyright year to 2024-2026
  • Update docs dev server port to 8288

Commits

  • b5bfe56 feat(docs): add CSP directives and fix eslint tsconfigRootDir
  • 42ea4c6 refactor(docs): migrate to @humanspeak/docs-kit shared library
  • a823021 build: replace concurrently with mprocs for dev workflow
  • 9260a47 chore: update tooling config and license year

jaysin586 and others added 4 commits March 4, 2026 20:21
- Update LICENSE copyright to 2024-2026
- Update trunk plugins and linter versions
- Add worker-configuration.d.ts and convex to trunk ignore
- Clear .ncuskip files
- Add social cards and mprocs.log to .gitignore

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Add mprocs.yaml with procs for urls, pkg, docs, sitemap, social
- Add scripts/dev-urls.mjs for dev server port discovery
- Add cf-typegen script for Cloudflare worker types
- Update dependency versions

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Replace local Sidebar, Breadcrumb, SEO, Header, Footer with docs-kit
- Add docsConfig and docsNav for centralized configuration
- Switch from lucide-svelte barrel imports to deep imports
- Add social card generation and GitHub stats fetching
- Add OG component and layout server data loading
- Update all page SEO to use docs-kit getSeoContext
- Update dev server port to 8288

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
- Configure Content Security Policy headers for docs site
- Set tsconfigRootDir in root and docs ESLint configs to resolve
  monorepo parsing errors

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Mar 5, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 537bda0f-c4d6-48b8-99e6-53c49a0e0685

📥 Commits

Reviewing files that changed from the base of the PR and between b5bfe56 and ca12ea1.

📒 Files selected for processing (1)
  • pnpm-workspace.yaml

📝 Walkthrough

Walkthrough

Integrates @humanspeak/docs-kit across the docs site, replacing local SEO, breadcrumb, header, sidebar, and footer implementations; migrates icons from Font Awesome to Lucide; adds docs build scripts (GitHub stats, social cards), tooling/config updates, CSP, mprocs, and various dependency bumps.

Changes

Cohort / File(s) Summary
Repo config & tooling
/.gitignore, /.ncuskip, docs/.ncuskip, .trunk/trunk.yaml, /LICENSE, /eslint.config.mjs, docs/eslint.config.mjs, /package.json, pnpm-workspace.yaml
Ignore adjustments, trunk linter/tool version bumps, eslint tsconfigRootDir addition, LICENSE year update, workspace built-deps entry, and package script/dependency updates.
Dev orchestration & CSP
/mprocs.yaml, /scripts/dev-urls.mjs, docs/svelte.config.js, docs/vite.config.ts
Add mprocs process file, new dev-urls helper script, introduce CSP directives, and change docs dev port.
Docs-kit integration & providers
docs/src/hooks.server.ts, docs/src/lib/docs-config.ts, docs/src/lib/docsNav.ts, docs/package.json, docs/src/routes/+layout.svelte, docs/src/routes/docs/+layout.server.ts, docs/src/routes/docs/+layout.svelte
Introduce docs-kit config and nav, wire Seo/Breadcrumb providers and SeoHead, move server-side otherProjects fetch to docs-kit load usage, and update layout to provider-driven SEO/JSON‑LD.
Removed local contexts & components
docs/src/lib/components/contexts/Breadcrumb/*, docs/src/lib/components/contexts/Seo/*, docs/src/routes/docs/Sidebar.svelte
Delete local breadcrumb and SEO context helpers/components and the custom Sidebar (functionality now provided by docs-kit).
Icon & component migrations
docs/src/lib/components/general/Header.svelte, docs/src/lib/components/general/Footer.svelte, docs/src/lib/components/general/Example.svelte, docs/src/lib/examples/*, docs/src/routes/+page.svelte, docs/src/routes/examples/**
Replace Font Awesome usage with Lucide components; swap custom Header/Footer with docs-kit Header/Footer; update many example pages to use Component-typed icons.
Styling & assets
docs/src/app.css, docs/src/app.html, docs/src/lib/github-stats.json, docs/src/lib/sitemap-manifest.json
Remove local theme tokens in favor of docs-kit base styles, remove Font Awesome CDN, add small decorative CSS, add generated github-stats.json, and update sitemap timestamps.
Docs build scripts
docs/scripts/fetch-github-stats.ts, docs/scripts/generate-social-cards.ts, scripts/dev-urls.mjs
Add scripts to fetch GitHub stats and generate social cards via @humanspeak/docs-kit, plus the dev-urls utility.
Page-level SEO hooks
Multiple docs/src/routes/docs/**/+page.svx and related pages
Add per-page inline scripts that call docs-kit getSeoContext() to set title/description/OG metadata across many docs pages.
Removed API route
docs/src/routes/api/other-projects/+server.ts
Delete local server route; otherProjects now fetched via docs-kit server load.

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~45 minutes

Possibly related PRs

Suggested labels

documentation, enhancement

Poem

🎨 Docs refreshed, components lean and bright,
Lucide icons gleam in morning light.
Providers hum, social cards take flight,
GitHub stars in JSON, sitemap dates in sight. 🚀

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: migration to docs-kit and replacement of concurrently with mprocs.
Description check ✅ Passed The description is comprehensive and relates directly to the changeset, covering refactoring, new features, build changes, and other updates.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feature-udpated-version

Comment @coderabbitai help to get the list of available commands and usage tips.

@jaysin586 jaysin586 added the skip-publish This is something important, but we dont want to publish it label Mar 5, 2026
@jaysin586 jaysin586 self-assigned this Mar 5, 2026
Fixes CI failure where pnpm refuses to build the git-hosted
@humanspeak/docs-kit dependency without explicit allowlisting.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@jaysin586 jaysin586 merged commit f2bb9b8 into main Mar 5, 2026
5 checks passed
@jaysin586

Copy link
Copy Markdown
Contributor Author

⏭️ NPM publishing was skipped due to the skip-publish label.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

skip-publish This is something important, but we dont want to publish it

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant