Skip to content

docs: update the documentation page.#73

Merged
thruflo merged 9 commits into
mainfrom
thruflo/docs
May 13, 2025
Merged

docs: update the documentation page.#73
thruflo merged 9 commits into
mainfrom
thruflo/docs

Conversation

@thruflo
Copy link
Copy Markdown
Contributor

@thruflo thruflo commented May 12, 2025

Add a conceptual introduction to describe how to use the library. Reorganise the API reference. Add e2e examples for TanStack Query and Electric usage that illustrates typical collection type + mutationFn pattern.

https://github.com/TanStack/db/blob/thruflo/docs/docs/index.md

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 12, 2025

⚠️ No Changeset found

Latest commit: 0450b81

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@pkg-pr-new
Copy link
Copy Markdown

pkg-pr-new Bot commented May 12, 2025

examples/react/todo

npm i https://pkg.pr.new/@tanstack/db@73
npm i https://pkg.pr.new/@tanstack/db-collections@73
npm i https://pkg.pr.new/@tanstack/react-db@73

commit: 0450b81

Copy link
Copy Markdown
Collaborator

@KyleAMathews KyleAMathews left a comment

Choose a reason for hiding this comment

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

Looking great!

We need to fit in somewhere that about how transaction lifecycles can be manually controlled.

E.g.

const addTodo = useOptimisticMutation({ mutationFn })

const addTodoTx = addTodo.createTransaction()

addTodoTx.mutate(() => {}

// user reviews change

// Another mutation
addTodoTx.mutate(() => {}

// Mutation is approved
addTodTx.commit()

Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
@KyleAMathews KyleAMathews added this to the v0.1.0 Release milestone May 12, 2025
@thruflo thruflo marked this pull request as ready for review May 13, 2025 09:09
@thruflo thruflo requested review from KyleAMathews and samwillis May 13, 2025 09:09
Copy link
Copy Markdown
Collaborator

@KyleAMathews KyleAMathews left a comment

Choose a reason for hiding this comment

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

Great stuff! A few minor suggestions but this is ready to go

Comment thread docs/index.md
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
Comment thread docs/index.md Outdated
@thruflo thruflo merged commit 55919b5 into main May 13, 2025
4 checks passed
@thruflo thruflo deleted the thruflo/docs branch May 13, 2025 13:08
cursor Bot pushed a commit that referenced this pull request Jul 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants