Merge pull request #723 from GetStream/docusaurus

Docusaurus soft release

Author: tsirlucas

.eslintrc.json

@@ -76,8 +76,10 @@
   },
   "overrides": [
     {
-      "files": ["*.md"],
+      "files": ["*.md", "*.mdx"],
       "rules": {
+        "arrow-body-style": ["error", "as-needed"],
+        "arrow-parens": ["error", "as-needed", { "requireForBlockBody": false }],
         "no-undef": 0,
         "react/jsx-no-undef": 0,
         "react/react-in-jsx-scope": 0,

.github/workflows/docusaurus.yml

@@ -3,7 +3,7 @@ name: docusaurus
 on:
   push:
     branches:
-      - docusaurus # default branch name for each repo that docs should be push from
+      - master # default branch name for each repo that docs should be push from
     paths:
       - docusaurus/**
 jobs:
@@ -13,5 +13,7 @@ jobs:
       - uses: actions/checkout@v2
       - name: push
         uses: GetStream/push-stream-chat-docusaurus-action@main
+        with:
+          target-branch: production
         env:
           DOCUSAURUS_GH_TOKEN: ${{ secrets.DOCUSAURUS_GH_TOKEN }}

.prettierrc

@@ -4,5 +4,18 @@
   "printWidth": 100,
   "singleQuote": true,
   "tabWidth": 2,
-  "trailingComma": "all"
+  "trailingComma": "all",
+  "overrides": [
+    {
+      "files": ["*.md", "*.mdx"],
+      "options": {
+        "arrowParens": "avoid",
+        "jsxSingleQuote": true,
+        "printWidth": 120,
+        "singleQuote": true,
+        "tabWidth": 2,
+        "trailingComma": "all"
+      }
+    }
+  ]
 }

docusaurus/docs/reactnative/additional-resources/_category_.json

@@ -0,0 +1,5 @@
+{
+    "label": "Additional Resources",
+    "position": 8
+  }
+  

docusaurus/docs/reactnative/additional-resources/libraries.mdx

@@ -0,0 +1,34 @@
+---
+id: libraries
+sidebar_position: 2
+title: Libraries
+---
+
+### [React Navigation Docs](https://reactnavigation.org/docs/getting-started/)
+
+Our tutorials, guides and sample apps are all using React Navigation. We recommend using it in 
+order to provide better support for all the use cases displayed.
+
+### [Gesture Handler Docs](https://docs.swmansion.com/react-native-gesture-handler/docs/)
+
+React Native Gesture Handler is used inside of our SDK on our channels and messages lists. Also used
+on our gallery, chat buttons, and reactions overlay.
+
+### [Markdown Lib Docs](https://github.com/andangrd/react-native-markdown-package)
+
+React Native Markdown Package is used to render markdown on our messages.
+
+### [Reanimated Lib Docs](https://docs.swmansion.com/react-native-reanimated/docs)
+
+React Native Reanimated is used to create our own beautiful custom animations in our gallery, attachment picker, 
+message actions/reactions and loading indicators/skeletons.
+
+### [Day.js Docs](https://day.js.org/docs/en/installation/installation)
+
+We are using Day.js to manipulate, customize, parse and display dates through the app.
+You may want to use it when creating you own custom components.
+
+### [React Native SVG](https://github.com/react-native-svg/react-native-svg)
+
+React Native SVG is one of our peer dependencies. We use it to render icons and a couple of small indicators
+through the app.

docusaurus/docs/reactnative/additional-resources/stream.mdx

@@ -0,0 +1,22 @@
+---
+id: stream-additional-resources
+sidebar_position: 1
+title: Stream Additional Resources
+---
+
+### [Demos](https://github.com/GetStream/react-native-samples)
+
+Stream Chat for React Native has multiple examples in the repo.
+In addition we have "cloned" some popular UIs to help demonstrate the flexibility of the SDK.
+
+### [JavaScript Client](https://getstream.io/chat/docs/javascript/?language=javascript)
+
+Stream Chat for React Native uses the Stream Chat JS client under the hood for most interactions with the backend.
+The client documentation covers a wide range of interactions that can be performed, not all of these are used within 
+the Stream Chat for React Native SDK but can be integrated within your own app as required.
+
+### [API Tutorial](https://getstream.io/chat/get_started/)
+
+To help you get acquainted with the Stream Chat JS client we have an easy to follow tutorial on our website.
+This is a great primer for using the client directly and can also help you understand how the Stream Chat for 
+React Native SDK if functioning under the hood.

docusaurus/docs/reactnative/additional-resources/technologies_and_techniques.mdx

@@ -0,0 +1,21 @@
+---
+id: technologies-and-techniques
+sidebar_position: 3
+title: Technologies & Techniques
+---
+
+### [Typescript Generics](https://www.typescriptlang.org/docs/handbook/2/generics.html)
+
+Our SDK is written in Typescript and heavily uses generics in order to allow users to use custom data and
+still have decent typing support.
+
+### [React Context](https://reactjs.org/docs/context.html)
+
+We rely on multiple contexts in our SDK to access components, functions, and data. 
+Context also allows you as a developer to override our defaults for many of these throughout the SDK. 
+Understanding how to draw upon values in context is important to customizing the SDK for your own needs.
+
+### [React Hooks](https://reactjs.org/docs/hooks-intro.html)
+
+We use/expose a bunch of our component's hooks so users can use them in order to replicate some behaviour/data 
+parsing when creating custom components. Understanding how to work with hooks can come in very handy.