Merge pull request #115 from GetStream/docusaurus-publish

chore: Publish docs to docusaurus #101

Author: szuperaz

.github/workflows/workflow.yml

@@ -14,7 +14,9 @@ jobs:
         node-version: [16.x]
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
 
       - name: Cache node modules
         uses: actions/cache@v1
@@ -51,3 +53,16 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
         run: npx semantic-release
+      - name: Verify docs changed
+        uses: tj-actions/[email protected]
+        with:
+          files: |
+            docusaurus
+        id: changed_files
+      - name: Push to docusaurus
+        if: steps.changed_files.outputs.any_changed == 'true'
+        uses: GetStream/push-stream-chat-docusaurus-action@main
+        with:
+          target-branch: ${{ github.ref == 'refs/heads/master' && 'staging' || 'staging' }}
+        env:
+          DOCUSAURUS_GH_TOKEN: ${{ secrets.DOCUSAURUS_GH_TOKEN }}

README.md

@@ -35,7 +35,7 @@ For complete pricing and details visit our [Chat Pricing Page](https://getstream
 ### Install with NPM
 
 ```
-npm install npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
+npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
 ```
 
 ## Sample App

docusaurus/docs/Angular/basics/getting-started.mdx

@@ -0,0 +1,38 @@
+---
+id: overview
+sidebar_position: 1
+slug: /
+title: Overview
+---
+
+Building on top of the Stream Chat API, the Stream Chat Angular component library includes everything you need to build feature-rich and high-functioning chat user experiences out of the box.
+The library includes an extensive set of performant and customizable Angular components which allow you to get started quickly with little to no plumbing required.
+Use cases include team and social messaging and customer support. The library supports:
+
+- Rich media messages
+- Reactions
+- Image and file uploads
+- Read state
+- Channel and message lists
+
+## Architecture
+
+The library contains a set of components that contain all of the necessary features to build a performant chat UI. However, it is also possible to provide your own custom components instead of the built-in ones.
+
+If you want to, you can build your own chat UI from scratch but still take advantage of the library by using our services.
+
+The left navigation will guide you to the various documentation sections for information on everything regarding our robust component library. Check out the instructions below for adding the library to your Angular project.
+
+## Installation
+
+We recommended using the component library through a package manager. Stream Chat React is based on top of Stream's [JavaScript Client](https://getstream.io/chat/docs/javascript/?language=javascript).
+
+### Install with NPM
+
+```bash
+npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
+```
+
+## Tutorial
+
+Follow our [tutorial](https://getstream.io/tutorials/angular-chat/) and build your first Stream Angular chat application.

docusaurus/docs/Angular/basics/installation.mdx

@@ -35,7 +35,7 @@ For complete pricing and details visit our [Chat Pricing Page](https://getstream
 ### Install with NPM
 
 ```
-npm install npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
+npm install stream-chat-angular stream-chat-css stream-chat @ngx-translate/core
 ```
 
 ## Sample App