Web App#35
Conversation
|
Greptile SummaryThis PR updates the documentation (
Confidence Score: 3/5
Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Developer: monorepo root] --> B[vercel deploy --prod]
B --> C[Vercel reads pnpm-lock.yaml\nfrom repo root]
C --> D[Root Dir = apps/web\nBuild Cmd = next build]
D --> E{Route request}
E --> F[generateStaticParams returns empty array\n+ dynamicParams=true\n+ revalidate=false]
F --> G{Page in edge cache?}
G -- Yes --> H[Return cached HTML\ns-maxage=31536000]
G -- No --> I[Server Component renders on-demand]
I --> J[getContentProvider\nreads .md from Cloudflare R2]
J --> K[Parse frontmatter\nShiki highlight\nremark render]
K --> H
L[PageFind index ~61k files, ~400 MB] --> M[Cloudflare R2\nvia NEXT_PUBLIC_PAGEFIND_BASE_URL]
M --> N[Client search dialog]
Last reviewed commit: 9e4a623 |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| --- | ||
| "@lexbuild/cli": minor | ||
| "@lexbuild/core": minor | ||
| "@lexbuild/usc": minor | ||
| --- | ||
|
|
||
| Update for LexBuild deployment |
There was a problem hiding this comment.
Changeset includes packages with no code changes
This changeset marks @lexbuild/cli, @lexbuild/core, and @lexbuild/usc for a minor version bump, but this PR contains only documentation edits (CLAUDE.md files). None of those three packages have any source code changes in this diff.
Publishing a minor version bump for these packages without any actual changes will produce empty/misleading release notes and unnecessarily increment the version numbers. If this changeset is a carry-over from another branch or work stream, it should either be removed or moved to the PR where the corresponding code changes live.
Prompt To Fix With AI
This is a comment left during a code review.
Path: .changeset/brown-areas-dream.md
Line: 1-7
Comment:
**Changeset includes packages with no code changes**
This changeset marks `@lexbuild/cli`, `@lexbuild/core`, and `@lexbuild/usc` for a `minor` version bump, but this PR contains only documentation edits (`CLAUDE.md` files). None of those three packages have any source code changes in this diff.
Publishing a minor version bump for these packages without any actual changes will produce empty/misleading release notes and unnecessarily increment the version numbers. If this changeset is a carry-over from another branch or work stream, it should either be removed or moved to the PR where the corresponding code changes live.
How can I resolve this? If you propose a fix, please make it concise.| - **Content served from Cloudflare R2** in production (`CONTENT_STORAGE=s3` in `.env.production`). PageFind index (~61k files) also served from R2 via `NEXT_PUBLIC_PAGEFIND_BASE_URL`. | ||
| - **Root `.vercelignore`** excludes `downloads/`, `output/`, `apps/web/content/`, `apps/web/public/_pagefind/` to stay under Vercel's 10 MB upload limit. `apps/web/public/nav/` is NOT excluded (small static JSON needed for sidebar). | ||
| - **On-demand ISR** — pages use empty `generateStaticParams()` + `revalidate = false` so Vercel caches at the edge. Without this, Vercel forces `max-age=0` on dynamic routes. | ||
| - See `.claude/deployment.md` for the complete deployment guide, `apps/web/CLAUDE.md` for the full web app spec. |
There was a problem hiding this comment.
Referenced file .claude/deployment.md does not exist
The updated docs now say "See .claude/deployment.md for the complete deployment guide," but the .claude/ directory does not exist anywhere in the repository. Any developer (or AI assistant reading this guide) who follows this reference will hit a dead end.
Either create the file as part of this PR, or revert to a reference that already exists (e.g., apps/web/README.md) until the deployment guide is ready.
Prompt To Fix With AI
This is a comment left during a code review.
Path: CLAUDE.md
Line: 109
Comment:
**Referenced file `.claude/deployment.md` does not exist**
The updated docs now say "See `.claude/deployment.md` for the complete deployment guide," but the `.claude/` directory does not exist anywhere in the repository. Any developer (or AI assistant reading this guide) who follows this reference will hit a dead end.
Either create the file as part of this PR, or revert to a reference that already exists (e.g., `apps/web/README.md`) until the deployment guide is ready.
How can I resolve this? If you propose a fix, please make it concise.There was a problem hiding this comment.
Pull request overview
Updates the web app and root project documentation to reflect the current Vercel/R2 deployment model and caching strategy, and adds a changeset presumably intended to publish a release.
Changes:
- Clarifies web deployment steps (run Vercel deploy from monorepo root) and documents on-demand ISR requirements for edge caching.
- Documents CDN caching mechanics, Pagefind being served from R2, and related environment variables.
- Adds a changeset bumping
@lexbuild/core,@lexbuild/usc, and@lexbuild/clias a minor release.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| apps/web/CLAUDE.md | Updates web app operational docs: deployment location, ISR/caching explanation, Pagefind hosting details. |
| CLAUDE.md | Updates root “Web App Notes” with production URL, deployment constraints, R2 usage, and caching notes. |
| .changeset/brown-areas-dream.md | Adds a release changeset for three packages. |
| # Deploy app — must run from monorepo root (Vercel needs pnpm-lock.yaml) | ||
| vercel deploy --prod | ||
|
|
||
| # Or run full pipeline | ||
| bash scripts/deploy.sh | ||
| cd apps/web && bash scripts/deploy.sh |
There was a problem hiding this comment.
scripts/deploy.sh is referenced in the deployment instructions, but there is no apps/web/scripts/deploy.sh (and no deploy.sh anywhere in the repo). Update the docs to point at the actual deployment pipeline (e.g., the existing generate-* scripts + vercel deploy --prod), or add the missing script if it's intended to exist.
| - **Content served from Cloudflare R2** in production (`CONTENT_STORAGE=s3` in `.env.production`). PageFind index (~61k files) also served from R2 via `NEXT_PUBLIC_PAGEFIND_BASE_URL`. | ||
| - **Root `.vercelignore`** excludes `downloads/`, `output/`, `apps/web/content/`, `apps/web/public/_pagefind/` to stay under Vercel's 10 MB upload limit. `apps/web/public/nav/` is NOT excluded (small static JSON needed for sidebar). | ||
| - **On-demand ISR** — pages use empty `generateStaticParams()` + `revalidate = false` so Vercel caches at the edge. Without this, Vercel forces `max-age=0` on dynamic routes. | ||
| - See `.claude/deployment.md` for the complete deployment guide, `apps/web/CLAUDE.md` for the full web app spec. |
There was a problem hiding this comment.
This references .claude/deployment.md, but there is no .claude/ directory in the repo. Either add the missing deployment guide at that path, or update this link to the correct existing document so readers don't hit a dead end.
| - See `.claude/deployment.md` for the complete deployment guide, `apps/web/CLAUDE.md` for the full web app spec. | |
| - See `docs/architecture/overview.md` for architecture and deployment details, `apps/web/CLAUDE.md` for the full web app spec. |
| "@lexbuild/cli": minor | ||
| "@lexbuild/core": minor | ||
| "@lexbuild/usc": minor |
There was a problem hiding this comment.
This changeset bumps @lexbuild/{cli,core,usc} as a minor release, but the PR contents shown are documentation-only. If there are no user-facing code/API changes, please drop the changeset entirely (preferred) or adjust it to the appropriate level (likely patch) and scope.
| "@lexbuild/cli": minor | |
| "@lexbuild/core": minor | |
| "@lexbuild/usc": minor | |
| "@lexbuild/cli": patch | |
| "@lexbuild/core": patch | |
| "@lexbuild/usc": patch |
No description provided.