From 27ec03ca00381720aa32ad92e2032a822b0499f4 Mon Sep 17 00:00:00 2001 From: Matthew Pirocchi Date: Mon, 14 Apr 2025 14:23:51 -0400 Subject: [PATCH 1/3] Replace quickstart placeholder with links to high-level examples. --- .gitignore | 4 ++++ docs/quick-start.md | 9 +++++++-- 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index 003c0367..d0348422 100644 --- a/.gitignore +++ b/.gitignore @@ -26,6 +26,10 @@ coverage .next .svelte-kit +# developer-specific VS Code config files +.vscode/tasks.json +.vscode/launch.json + npm-debug.log* yarn-debug.log* yarn-error.log* diff --git a/docs/quick-start.md b/docs/quick-start.md index 591d6129..502e7543 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -3,6 +3,11 @@ title: Quick Start id: quick-start --- -TanStack Pacer is, first and foremost, a framework-agnostic utility library for rate limiting, throttling, debouncing, and queuing. +This page contains links to the the highest-level example for each of Tanstack Pacer's 4 core concepts: -It can be used with any of our framework adapters, but can also be used in vanilla JavaScript or TypeScript. \ No newline at end of file + * [Debouncing](./guides/debouncing.md): [`useDebouncedValue`](../examples/react/useDebouncedValue/) + * [Throttling](./guides/throttling.md): [`useThrottledValue`](../examples/react/useThrottledValue/) + * [Rate-limiting](./guides//rate-limiting.md): [`useRateLimitedValue`](../examples/react/useRateLimitedValue/) + * [Queueing](./guides/queueing.md): [`useQueuerState`](../examples/react/useQueuerState/) + +If you're looking lower-level examples or `async` examples, take a look at our catalog of [examples](../examples/). From c58ea0b30ff261e8bdffd3c0472ce1fa38096c04 Mon Sep 17 00:00:00 2001 From: Matthew Pirocchi Date: Mon, 14 Apr 2025 14:28:46 -0400 Subject: [PATCH 2/3] Fix typo. --- docs/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 502e7543..f02df470 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -7,7 +7,7 @@ This page contains links to the the highest-level example for each of Tanstack P * [Debouncing](./guides/debouncing.md): [`useDebouncedValue`](../examples/react/useDebouncedValue/) * [Throttling](./guides/throttling.md): [`useThrottledValue`](../examples/react/useThrottledValue/) - * [Rate-limiting](./guides//rate-limiting.md): [`useRateLimitedValue`](../examples/react/useRateLimitedValue/) + * [Rate-limiting](./guides/rate-limiting.md): [`useRateLimitedValue`](../examples/react/useRateLimitedValue/) * [Queueing](./guides/queueing.md): [`useQueuerState`](../examples/react/useQueuerState/) If you're looking lower-level examples or `async` examples, take a look at our catalog of [examples](../examples/). From ab4a55679179cbbd2e6d2ed1ba70e4bf2705bf6f Mon Sep 17 00:00:00 2001 From: Matthew Pirocchi Date: Wed, 16 Apr 2025 12:17:00 -0400 Subject: [PATCH 3/3] Address feedback from PR. --- docs/quick-start.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index f02df470..07a75f7c 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -10,4 +10,4 @@ This page contains links to the the highest-level example for each of Tanstack P * [Rate-limiting](./guides/rate-limiting.md): [`useRateLimitedValue`](../examples/react/useRateLimitedValue/) * [Queueing](./guides/queueing.md): [`useQueuerState`](../examples/react/useQueuerState/) -If you're looking lower-level examples or `async` examples, take a look at our catalog of [examples](../examples/). +If you're looking lower-level examples or `async` examples, take a look at our catalog of examples.