docs: readability pass on overview, quick start, devtools, and adapter pages

[KevinVandy]

Summary

A readability/copy-editing pass over the top-level docs pages. The framework guides were already in good shape, so this focuses on the pages around them. No API or behavioral content changes, prose only.

• overview.md: Rewrote the intro to name the five patterns and the concrete details Pacer handles (type safety, tree-shaking, cancellation, pending state) instead of ***bold-italic*** keyword hype. Tightened every feature bullet, fixed the adapter list (said "React, Solid, and more"; now "React, Preact, Solid, and Angular"), and gave Pacer Lite concrete guidance (apps use regular packages, libraries reach for Lite).
• quick-start.md: Fixed the "Famarilizing" typo and "If want" grammar error, cut redundant sentences, and noted that framework hooks clean up with the component lifecycle.
• devtools.md: Deduplicated the production-builds note, removed changelog-speak about keys no longer being auto-generated, cut "integrate seamlessly".
• React/Preact/Solid/Angular adapter pages: Simplified the circular intro and the wordy selector/provider paragraphs ("optimizing performance by preventing unnecessary updates when irrelevant state changes occur" is now "State you do not select never causes an update").
• All pages: Converted title-case headings to sentence case to match the guides. Anchor-safe (slugs are lowercased), and no inbound links point at the two headings whose wording changed.

Prettier passes on all changed files.

Note

docs/guides/server-rate-limiting.md is still an empty stub (frontmatter only). Left untouched here; it needs content or removal from the nav.

🤖 Generated with Claude Code

Summary by CodeRabbit

• Documentation
  • Clarified Devtools integration, production behavior, utility registration, and panel visibility.
  • Improved framework adapter guidance for Angular, Preact, React, and Solid, including lifecycle cleanup, subscriptions, selectors, providers, and option helpers.
  • Refined installation, quick-start, overview, and utility-selection guidance with clearer feature descriptions and sentence-case headings.
  • Updated debouncer documentation to explain latest-call behavior.
  • Simplified package documentation links to point directly to framework-level pages.

[nx-cloud]

View your CI Pipeline Execution ↗ for commit ad5d1c0

Command	Status	Duration	Result
nx run-many --targets=build --exclude=examples/**	✅ Succeeded	1s	View ↗

---

☁️ Nx Cloud last updated this comment at 2026-08-18 15:10:12 UTC

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 8f8c59e3-57ec-42e8-842d-13674dffc761

📥 Commits

Reviewing files that changed from the base of the PR and between a6c4edf and 2a261c3.

📒 Files selected for processing (18)

• docs/devtools.md
• docs/framework/angular/adapter.md
• docs/framework/preact/adapter.md
• docs/framework/react/adapter.md
• docs/framework/solid/adapter.md
• docs/guides/which-pacer-utility-should-i-choose.md
• docs/installation.md
• docs/overview.md
• docs/quick-start.md
• packages/angular-pacer/README.md
• packages/pacer-devtools/README.md
• packages/pacer-lite/README.md
• packages/pacer/README.md
• packages/preact-pacer-devtools/README.md
• packages/react-pacer-devtools/README.md
• packages/react-pacer/README.md
• packages/solid-pacer-devtools/README.md
• packages/solid-pacer/README.md

---

📝 Walkthrough

Walkthrough

The pull request revises Pacer documentation for overview, onboarding, devtools, framework adapters, utility guidance, installation, and package README links. It changes documentation wording and headings only. No public declarations or implementation code changed.

Changes

Documentation updates

Layer / File(s)	Summary
Onboarding and devtools guidance docs/overview.md, docs/quick-start.md, docs/installation.md, docs/devtools.md, docs/guides/which-pacer-utility-should-i-choose.md	Updated capability descriptions, setup guidance, devtools behavior, debouncer wording, and heading capitalization.
Framework adapter guidance docs/framework/angular/adapter.md, docs/framework/preact/adapter.md, docs/framework/react/adapter.md, docs/framework/solid/adapter.md	Clarified hook cleanup, reactive state, option helpers, provider defaults, subscriptions, selectors, and framework-specific usage.
Package README documentation links packages/*/README.md	Updated framework adapter links to use consolidated framework documentation paths.

Estimated code review effort: 2 (Simple) | ~15 minutes

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/readability-pass

---

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.}