Merge pull request #153 from vikejs/phonzammi/dev

docs: minor
vikejs · Nov 19, 2024 · b9f9b4d · b9f9b4d
2 parents 7a20055 + 77196fc
commit b9f9b4d
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -1,17 +1,2 @@
-[Vike extensions](https://vike.dev/extensions) for [React](https://react.dev).
-
-- `vike-react` (React integration)
-  - Docs: [vike.dev/vike-react](https://vike.dev/vike-react)
-  - Version history: [CHANGELOG.md](packages/vike-react/CHANGELOG.md)
-  - Source code: [packages/vike-react/](packages/vike-react)
-- `vike-react-query` ([TanStack Query](https://tanstack.com/query) integration)
-  - Docs: [README.md](packages/vike-react-query#readme)
-  - Version history: [CHANGELOG.md](packages/vike-react-query/CHANGELOG.md)
-  - Source code: [packages/vike-react-query/](packages/vike-react-query)
-- `vike-react-apollo` ([Apollo GraphQL](https://www.apollographql.com/docs/react) integration)
-  - Docs: [README.md](packages/vike-react-apollo#readme)
-  - Version history: [CHANGELOG.md](packages/vike-react-apollo/CHANGELOG.md)
-  - Source code: [packages/vike-react-apollo/](packages/vike-react-apollo)
-
-> [!NOTE]
-> The source code is [small, simple, and highly polished](https://vike.dev/vike-react#under-the-hood). Contributing is easy and welcome, see [CONTRIBUTING.md](CONTRIBUTING.md) to get started.
+Source code of following Vike React extensions: [Vike Docs > Extensions > React](https://vike.dev/extensions#react).  
+See [packages/](packages/).  
diff --git a/packages/vike-react-apollo/README.md b/packages/vike-react-apollo/README.md
@@ -5,17 +5,22 @@
 
 # `vike-react-apollo`
 
-Enables your React components to fetch data using [Apollo GraphQL](https://www.apollographql.com/docs/react/).
+Enables your React components to fetch data using [Apollo GraphQL](https://www.apollographql.com). Powered by [HTML streaming](https://github.com/brillout/react-streaming#readme).
 
 > [!NOTE]
-> You also get [progressive rendering](https://vike.dev/streaming#progressive-rendering), fallback upon loading and/or error, and [caching](https://www.apollographql.com/docs/react/caching/cache-configuration).
+> Includes:
+> - [Progressive rendering](https://vike.dev/streaming#progressive-rendering)
+> - [SSR benefits](https://github.com/brillout/react-streaming#ssr)
+> - Fallback upon loading and/or error
+> - [Caching](https://www.apollographql.com/docs/react/caching/cache-configuration).
 
 [Installation](#installation)  
 [Basic usage](#basic-usage)  
 [`withFallback()`](#withfallback)  
 [`<head>` tags](#head-tags)  
 [Error Handling](#error-handling)  
 [How it works](#how-it-works)  
+[Version history](https://github.com/vikejs/vike-react/blob/main/packages/vike-react-apollo/CHANGELOG.md)  
 [See also](#see-also)  
 
 <br/>
@@ -272,7 +277,8 @@ Upon page navigation (and rendering the first page if [SSR is disabled](https://
 ## See also
 
 - [Example](https://github.com/vikejs/vike-react/tree/main/examples/apollo)
-- [Vike > Data Fetching](https://vike.dev/data-fetching)
+- [Vike Docs > Apollo GraphQL](https://vike.dev/apollo-graphql)
+- [Vike Docs > Data Fetching](https://vike.dev/data-fetching)
 - [Apollo GraphQL > useSuspenseQuery](https://www.apollographql.com/docs/react/api/react/hooks/#usesuspensequery)
 - [Apollo GraphQL > Suspense](https://www.apollographql.com/docs/react/data/suspense/)
 - [React > `<Suspense>`](https://react.dev/reference/react/Suspense)
diff --git a/packages/vike-react-chakra/CHANGELOG.md b/packages/vike-react-chakra/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 ### Features
 
-* add vike-react-chakra ([#151](https://github.com/vikejs/vike-react/issues/151)) ([0850332](https://github.com/vikejs/vike-react/pull/151/commits/0850332bcc570145b6d548fe1add73427788b0bd))
+* new extension vike-react-chakra ([#151](https://github.com/vikejs/vike-react/issues/151)) ([0850332](https://github.com/vikejs/vike-react/pull/151/commits/0850332bcc570145b6d548fe1add73427788b0bd))
 
 
 
diff --git a/packages/vike-react-chakra/README.md b/packages/vike-react-chakra/README.md
@@ -2,6 +2,8 @@
 
 [Installation](#installation)  
 [Settings](#settings)  
+[Version history](https://github.com/vikejs/vike-react/blob/main/packages/vike-react-chakra/CHANGELOG.md)  
+[See Also](#see-also)  
 
 <br/>
 
@@ -42,7 +44,6 @@
 
 <br/>
 
-
 ## Settings
 
 `vike-react-chakra` provides a configuration `+chakra` for setting the theme system and locale.
@@ -76,3 +77,9 @@ You can remove Chakra from [some of your pages](https://vike.dev/config#inherita
 
 export const chakra = null
 ```
+
+<br/>
+
+## See also
+
+- [Vike Docs > Chakra UI](https://vike.dev/chakra)
diff --git a/packages/vike-react-query/README.md b/packages/vike-react-query/README.md
@@ -5,10 +5,10 @@
 
 # `vike-react-query`
 
-Enables your React components to fetch data using [TanStack Query](https://tanstack.com/query/latest).
+Enables your React components to fetch data using [TanStack Query](https://tanstack.com/query/latest). Powered by [HTML streaming](https://github.com/brillout/react-streaming#readme).
 
 > [!NOTE]
-> Including:
+> Includes:
 > - [Progressive rendering](https://vike.dev/streaming#progressive-rendering)
 > - [SSR benefits](https://github.com/brillout/react-streaming#ssr)
 > - Fallback upon loading and/or error
@@ -22,6 +22,7 @@ Enables your React components to fetch data using [TanStack Query](https://tanst
 [Settings](#settings)  
 [Usage with Telefunc](#usage-with-telefunc)  
 [How it works](#how-it-works)  
+[Version history](https://github.com/vikejs/vike-react/blob/main/packages/vike-react-query/CHANGELOG.md)  
 [See also](#see-also)  
 
 <br/>
@@ -437,5 +438,6 @@ Upon page navigation (and rendering the first page if [SSR is disabled](https://
 ## See also
 
 - [Example](https://github.com/vikejs/vike-react/tree/main/examples/react-query)
+- [Vike Docs > TanStack Query](https://vike.dev/tanstack-query)
 - [TanStack Query > useSuspenseQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useSuspenseQuery)
-- [Vike > Data Fetching](https://vike.dev/data-fetching)
+- [Vike Docs > Data Fetching](https://vike.dev/data-fetching)
diff --git a/packages/vike-react/README.md b/packages/vike-react/README.md
@@ -1,2 +1 @@
-Docs: [vike.dev/vike-react](https://vike.dev/vike-react)  
-Source code: [GitHub > vikejs/vike-react](https://github.com/vikejs/vike-react)
+See [Vike Docs > vike-react](https://vike.dev/vike-react).