feat: update docs

[kasin-it]

Summary by CodeRabbit

• Documentation
  • Raised Node.js requirement to ≥24.
  • Expanded Quick Start into step-by-step monitor + SDK setup and clarified SDK endpoint requirement.
  • Rewrote development setup with explicit components, watch-mode tip (pnpm dev:client) and commit-message guidance.
  • Reorganized contribution/code-style guidance with structured responsibilities.
  • Added reminder to change the initial user password before public deployment.
  • Updated schema example docs to include INP and CLS.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
next-cwv-monitor-client-app	Ready	Preview, Comment	Mar 3, 2026 0:14am
next-cwv-monitor-monitor-app	Ready	Preview, Comment	Mar 3, 2026 0:14am

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 43b948c and 34a3a90.

📒 Files selected for processing (1)

• CONTRIBUTING.md

📜 Recent review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: check_pull_request

🔇 Additional comments (3)

CONTRIBUTING.md (3)

16-16: Clear runtime baseline update.

The Node.js requirement bump is explicit and easy to follow for contributors.

---

28-37: Good onboarding clarity for local development.

The service breakdown, login hint, and pnpm dev:client note make the setup flow much more actionable.

---

65-72: Commit message guidance is now lint-safe and clearer.

Using a typed fence (text) and concrete examples improves readability and satisfies markdownlint expectations.

---

📝 Walkthrough

Walkthrough

This PR updates repository documentation: raises the Node.js requirement to ≥24; expands development setup guidance with explicit components and watch-mode tips; rewrites README content for monitor-app and client-app into complete setup flows; adds a security reminder to change the initial monitor password; and updates schema and SDK README examples.

Changes

Cohort / File(s)	Summary
Development & Contribution Guides CONTRIBUTING.md, DEPLOYMENT.md	Node.js requirement raised to ≥24; CONTRIBUTING expanded with explicit dev components (ClickHouse, migrations, monitor-app, seed-demo), watch-mode tip (pnpm dev:client), updated commit guidance and reorganized code-style responsibilities; DEPLOYMENT adds instruction to change INITIAL_USER_PASSWORD before public exposure.
Primary Project Documentation README.md	Quick Start replaced with a stepwise setup covering monitor and SDK: clone, setup, docker steps, dashboard URL, project creation, obtaining project UUID, and SDK installation; Provider snippet comments clarified (projectId and production endpoint).
Application READMEs apps/client-app/README.md, apps/monitor-app/README.md	Client-app README refocused for SDK demo, instructs running from repo root with pnpm docker:dev and pnpm dev:client, removed legacy Next.js learn/deploy sections; monitor-app README rewritten to describe ingest API and dashboard UI, ClickHouse launch options, stack links, and further reading.
Schema & SDK Documentation apps/monitor-app/clickhouse/SCHEMA.md, packages/client-sdk/README.md	Schema docs updated example metric list to include INP and CLS; client SDK README clarified that the SDK endpoint must point to a running monitor and links to self-hosting deployment guide.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• chore: upgrade node version to current LTS #115: Shared change to Node.js version requirement (upgrade from 20 to 24) across project tooling and configuration.

Suggested reviewers

• iipanda
• Levosilimo

Poem

🥕 In burrows of docs I nibble and write,

I hop through READMEs by soft candlelight,
Node bumped and guides now clearer in view,
A watch-mode tip, a password reminder too,
Hop on — the setup's ready, fresh as dew.

🚥 Pre-merge checks | ✅ 1 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'feat: update docs' is vague and generic, using non-descriptive terms that don't convey meaningful information about what documentation was updated or why.	Provide a more specific title that indicates the main documentation updates, such as 'feat: update docs with Node.js 24 requirement and setup instructions' or similar.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ 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 update-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CONTRIBUTING.md`:
- Around line 67-72: The fenced code block containing commit examples currently
has no language specified (the triple backticks around the four commit lines);
update that block to include a language identifier such as text (i.e. change ```
to ```text) so markdownlint MD040 is satisfied, keeping the existing commit
lines unchanged.

---

ℹ️ Review info

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 86009a7 and 43b948c.

📒 Files selected for processing (7)

• CONTRIBUTING.md
• DEPLOYMENT.md
• README.md
• apps/client-app/README.md
• apps/monitor-app/README.md
• apps/monitor-app/clickhouse/SCHEMA.md
• packages/client-sdk/README.md

📜 Review details

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: check_pull_request

🧰 Additional context used

🧠 Learnings (1)

📚 Learning: 2026-02-27T10:22:20.131Z

Learnt from: olekszczepanowski
Repo: Blazity/next-cwv-monitor PR: 118
File: apps/monitor-app/src/app/api/chat/[projectId]/route.ts:4-14
Timestamp: 2026-02-27T10:22:20.131Z
Learning: In the next-cwv-monitor codebase (apps/monitor-app), the proxy.ts middleware handles authentication by redirecting unauthenticated users to /login. Routes not in PUBLIC_ROUTES array (["/login", "/api/auth", "/api/health", "/api/ingest"]) are automatically protected by this authentication layer.

Applied to files:

• apps/monitor-app/README.md
• packages/client-sdk/README.md
• apps/client-app/README.md

🪛 markdownlint-cli2 (0.21.0)

CONTRIBUTING.md

[warning] 67-67: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (6)

apps/monitor-app/clickhouse/SCHEMA.md (1)

29-29: Good clarification of metric_name examples.

Including INP and CLS on Line 29 makes the schema docs more explicit and up to date for modern CWV metrics.

packages/client-sdk/README.md (1)

17-17: Helpful endpoint requirement note.

The added callout on Line 17 reduces setup ambiguity and points users to the correct deployment guide.

DEPLOYMENT.md (1)

37-37: Strong security checklist addition.

Line 37 clearly calls out changing INITIAL_USER_PASSWORD before public exposure, which is an important hardening step.

apps/monitor-app/README.md (1)

1-32: README rewrite is clear and well-structured.

The updated sections (purpose, local startup path, stack, and doc links) provide a cleaner onboarding path and reduce confusion around pnpm docker:dev vs local pnpm dev.

apps/client-app/README.md (1)

1-20: Good developer-experience cleanup.

The updated quick-start and SDK integration pointers are concise and correctly direct contributors to pnpm dev:client and the SDK docs.

README.md (1)

46-80: Quick Start expansion is strong and actionable.

The new three-step flow (run monitor → create project → add SDK) improves first-run success and makes required context explicit, especially around projectId and endpoint on Lines 78–80.