docs: add cliparr.dev Astro website#82
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
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/wwwAstro + 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.tsviascripts/sync-readme.ts; rootdev:web/build:web/docs:sync/docs:checkscripts added anddocs:checkwired into the CI workflow. - Workspace updates: allow
sharpbuilds inpnpm-workspace.yaml, knip ignores forapps/www,.gitignoreadds.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.
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
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.
Summary
@cliparr/www, a static Astro site for cliparr.dev with TypeScript, Tailwind v4, MDX content collections, sitemap generation, syntax highlighting, and Astro view transitions.dev:weband docs scripts, and a CI docs check.Impact
Validation
pnpm --filter @cliparr/www lint:typespnpm --filter @cliparr/www buildpnpm docs:checkpnpm lintpnpm testpnpm knippnpm build