Skip to content

docs: update query refresh/update sections #14675

@hyunbinseo

Description

@hyunbinseo

Describe the problem

Unify expressions

Same goal, different terms. Maybe they can be unified to Updating Queries?

Provide reference

The command section shows both

but the latter is not linked to its source for easy reference.

It just says 'as before', so I had to search for the override keyword in the page.

...or when we call it:

await addLike(item.id).updates(getLikes(item.id));

As before, we can use withOverride for optimistic updates:

await addLike(item.id).updates(
  getLikes(item.id).withOverride((n) => n + 1)
);

Describe the proposed solution

Alongside the above edits,

  • Don't assume that a reader read the docs in order
  • Separate each remote functions into independent pages
  • Or at least show the parent section name

I cannot know that I am in a command section in a narrow viewport. The situation is not much different in a wider viewport, since I have to look at the right sidebar to monitor which section I am in.

Image

Alternatives considered

No response

Importance

nice to have

Additional Information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions