Skip to content

Replace quickstart placeholder with links to high-level examples. #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Replace quickstart placeholder with links to high-level examples. #8

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
27ec03c
Replace quickstart placeholder with links to high-level examples.
mpiroc Apr 14, 2025
c58ea0b
Fix typo.
mpiroc Apr 14, 2025
ab4a556
Address feedback from PR.
mpiroc Apr 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand Down
9 changes: 7 additions & 2 deletions docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
* [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/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

going to need to not link to the root examples directory. It's kind of a bug that this doesn't redirect right now.