Skip to content

docs: add cliparr.dev Astro website#82

Merged
KyleTryon merged 6 commits into
mainfrom
codex/cliparr-www-site
May 28, 2026
Merged

docs: add cliparr.dev Astro website#82
KyleTryon merged 6 commits into
mainfrom
codex/cliparr-www-site

Conversation

@KyleTryon
Copy link
Copy Markdown
Contributor

Summary

  • Add @cliparr/www, a static Astro site for cliparr.dev with TypeScript, Tailwind v4, MDX content collections, sitemap generation, syntax highlighting, and Astro view transitions.
  • Build a minimal product homepage plus docs routes for getting started, configuration, local videos, providers, and development.
  • Add canonical product/docs data, README sync/check scripts, root dev:web and docs scripts, and a CI docs check.

Impact

  • Introduces the public cliparr.dev website without changing frontend or backend runtime APIs.
  • Keeps duplicated README product facts generated from the website data so docs drift is easier to catch in CI.

Validation

  • pnpm --filter @cliparr/www lint:types
  • pnpm --filter @cliparr/www build
  • pnpm docs:check
  • pnpm lint
  • pnpm test
  • pnpm knip
  • pnpm build

@KyleTryon KyleTryon marked this pull request as ready for review May 28, 2026 19:24
@KyleTryon KyleTryon requested a review from Copilot May 28, 2026 19:24
Copy link
Copy Markdown
Contributor

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

Adds a new @cliparr/www Astro workspace package that ships the static cliparr.dev marketing site and docs. The site reuses canonical product/docs data (src/data/product.ts) that also drives README sections via a sync script enforced in CI, so docs drift is detected automatically. README copy is rewritten and wrapped in CLIPARR_DOCS_SYNC markers to match the generated source of truth.

Changes:

  • New apps/www Astro + Tailwind v4 + MDX site with homepage, docs index, and per-doc MDX routes, plus SEO/robots/sitemap, theming, and view-transition-friendly layout components.
  • README synced from apps/www/src/data/product.ts via scripts/sync-readme.ts; root dev:web/build:web/docs:sync/docs:check scripts added and docs:check wired into the CI workflow.
  • Workspace updates: allow sharp builds in pnpm-workspace.yaml, knip ignores for apps/www, .gitignore adds .astro/.

Reviewed changes

Copilot reviewed 32 out of 44 changed files in this pull request and generated no comments.

Show a summary per file
File Description
README.md Rewords product copy and adds CLIPARR_DOCS_SYNC markers around features/quick-start/configuration sections.
pnpm-workspace.yaml Allows the sharp install build (used by Astro image optimization).
package.json Adds dev:web, build:web, docs:sync, docs:check workspace scripts.
knip.json Adds apps/www knip config and ignored dependencies.
.gitignore Ignores Astro's .astro/ cache directory.
.github/workflows/ci.yml Runs pnpm docs:check in CI to catch README drift.
apps/www/package.json Defines the new Astro package, deps, and scripts.
apps/www/astro.config.ts Configures site URL, MDX, sitemap, Tailwind Vite plugin, Shiki theme.
apps/www/tsconfig.json, tsconfig.scripts.json Astro strict TS config and a separate scripts config for the sync script.
apps/www/src/env.d.ts Astro/Vite type references.
apps/www/src/content.config.ts Defines the docs content collection schema.
apps/www/src/data/product.ts Canonical product/site/feature/env/warning data shared between site and README.
apps/www/src/content/docs/*.mdx Getting started, configuration, local-videos, providers, development docs.
apps/www/src/components/*.astro BaseLayout, Header, Footer, DocsLayout, DocsNav, Callout, CommandBlock, FeatureGrid, EnvVarTable.
apps/www/src/pages/index.astro Marketing homepage with hover-to-play editor preview.
apps/www/src/pages/docs/index.astro, [...slug].astro Docs index and dynamic per-entry route.
apps/www/src/pages/robots.txt.ts Generates robots.txt referencing sitemap-index.xml.
apps/www/src/styles/global.css Tailwind v4 theme tokens, prose-docs styles, theming toggles.
apps/www/scripts/sync-readme.ts Renders product data into README markers; supports --write and check modes.
apps/www/public/_headers, providers/*.svg, logo-light.svg Static assets and Cache-Control / security headers for hosting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@KyleTryon KyleTryon merged commit 26b3a50 into main May 28, 2026
3 checks passed
@KyleTryon KyleTryon changed the title [codex] add cliparr.dev Astro website docs: add cliparr.dev Astro website May 28, 2026
@KyleTryon KyleTryon deleted the codex/cliparr-www-site branch May 31, 2026 07:31
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.

2 participants