[📖] useServerData (in v2)
Open
Nobody has claimed this yet.
docs
PR welcomed
- Dominant language
- TypeScript
- Stars
- 22.1k
- Forks
- 1.4k
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 52
Description
Suggestion
The documentation for useServerData is currently empty.
@manucorporat mentions in https://github.com/QwikDev/qwik/issues/4506#issuecomment-1597801559:
it's a very low level API, that most developers should never have to use
Should it be mentioned in the docs?
More points:
- It's not clear in what contexts
useServerDatashould work. Is it supported in therouteLoader$, for example? - What is the recommended (high level) alternative for a global server context accessible in
routeLoader$,onStaticGenerate, ... ?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the currently empty useServerData documentation and the discussion in issue #4506 linked from this report. Clarify which contexts support useServerData, including routeLoader$ if applicable, and document the recommended high-level alternative for shared server context; the documentation is complete when these questions are answered.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100