Mirror: The highly customizable and versatile GraphQL client with which you add on features like normalized caching as you grow.
docs: Add note on how urql publishes new versions
+21
-1
+21
-1
README.md
+21
-1
README.md
···
43
43
44
44
If you'd like to get involved, [check out our Contributor's guide.](https://github.com/urql-graphql/urql/blob/main/CONTRIBUTING.md)
45
45
46
-
## 📃 [Documentation](https://formidable.com/open-source/urql/docs/)
46
+
## 📦 [Releases](https://github.com/urql-graphql/urql/releases)
47
+
48
+
All new releases and updates are listed on GitHub with full changelogs. Each package in this
49
+
repository further contains an independent `CHANGELOG.md` file with the historical changelog, for
50
+
instance, [here’s `@urql/core`’s
51
+
changelog](https://github.com/urql-graphql/urql/blob/main/packages/core/CHANGELOG.md).
52
+
53
+
If you’re upgrading to v4, [check out our migration guide, posted as an
54
+
issue.](https://github.com/urql-graphql/urql/issues/3114)
55
+
56
+
New releases are prepared using
57
+
[changesets](https://github.com/urql-graphql/urql/blob/main/CONTRIBUTING.md#how-do-i-document-a-change-for-the-changelog),
58
+
which are changelog entries added to each PR, and we have “Version Packages” PRs that once merged
59
+
will release new versions of `urql` packages. You can use `@canary` releases from `npm` if you’d
60
+
like to get a preview of the merged changes.
61
+
62
+
## 📃 [Documentation](https://urql.dev/goto/docs)
47
63
48
64
The documentation contains everything you need to know about `urql`, and contains several sections in order of importance
49
65
when you first get started:
···
53
69
- **[Advanced](https://formidable.com/open-source/urql/docs/advanced/)** — covers more uncommon use-cases and things you don't immediately need when getting started.
54
70
- **[Graphcache](https://formidable.com/open-source/urql/docs/graphcache/)** — documents ["Normalized Caching" support](https://formidable.com/open-source/urql/docs/graphcache/normalized-caching/) which enables more complex apps and use-cases.
55
71
- **[API](https://formidable.com/open-source/urql/docs/api/)** — the API documentation for each individual package.
72
+
73
+
Furthermore, all APIs and packages are self-documented using TSDocs. If you’re using a language
74
+
server for TypeScript, the documentation for each API should pop up in your editor when hovering
75
+
`urql`’s code and APIs.
56
76
57
77
_You can find the raw markdown files inside this repository's `docs` folder._
58
78