chore: cr fixes and styles updates

callstack · Nov 28, 2024 · 4abbb28 · 4abbb28
1 parent 7cda312
commit 4abbb28
Show file tree

Hide file tree

Showing 20 changed files with 419 additions and 59 deletions.
diff --git a/docs/package.json b/docs/package.json
@@ -13,5 +13,8 @@
     "rspress": "^1.35.1",
     "ts-node": "^10.9.2",
     "typescript": "^5.6.3"
+  },
+  "dependencies": {
+    "rspress-plugin-font-open-sans": "^1.0.0"
   }
 }
diff --git a/docs/rspress.config.ts b/docs/rspress.config.ts
@@ -1,9 +1,32 @@
 import { defineConfig } from 'rspress/config';
+import { pluginFontOpenSans } from 'rspress-plugin-font-open-sans';
+import * as path from 'node:path';
 
 export default defineConfig({
   root: 'src',
   base: '/byorg-ai/',
-  title: 'byorg-ai',
+  title: 'byorg.ai',
+  icon: '/img/favicon.ico',
   description: 'TypeScript framework for writing chatbot applications.',
-  plugins: [],
+  logo: {
+    light: '/img/logo_mono_light.svg',
+    dark: '/img/logo_mono_dark.svg',
+  },
+  globalStyles: path.join(__dirname, 'src/styles/index.css'),
+  themeConfig: {
+    enableContentAnimation: true,
+    enableScrollToTop: true,
+    outlineTitle: 'Contents',
+    footer: {
+      message: 'Copyright © 2024 Callstack Open Source',
+    },
+    socialLinks: [
+      {
+        icon: 'github',
+        mode: 'link',
+        content: 'https://github.com/callstack/byorg-ai',
+      },
+    ],
+  },
+  plugins: [pluginFontOpenSans()],
 });
diff --git a/docs/src/_meta.json b/docs/src/_meta.json
@@ -3,10 +3,5 @@
     "text": "Docs",
     "link": "/docs/about",
     "activeMatch": "^/docs/"
-  },
-  {
-    "text": "API",
-    "link": "/api/about",
-    "activeMatch": "^/api/"
   }
 ]
diff --git a/docs/src/api/_meta.json b/docs/src/api/_meta.json
diff --git a/docs/src/api/about.md b/docs/src/api/about.md
diff --git a/docs/src/api/core/_meta.json b/docs/src/api/core/_meta.json
diff --git a/docs/src/api/core/index.md b/docs/src/api/core/index.md
diff --git a/docs/src/api/slack/_meta.json b/docs/src/api/slack/_meta.json
diff --git a/docs/src/api/slack/index.md b/docs/src/api/slack/index.md
diff --git a/docs/src/docs/about.md b/docs/src/docs/about.md
@@ -2,7 +2,7 @@
 
 ## Introduction
 
-byorg.ai is a framework designed for the rapid development and deployment of AI assistants within companies and organizations.
+byorg.ai is a framework designed for rapid development and deployment of AI assistants within companies and organizations.
 
 ## Supported Integrations
 

diff --git a/docs/src/docs/core/usage.mdx b/docs/src/docs/core/usage.mdx
@@ -45,7 +45,7 @@ Here is step by step how to start with byorg.
     systemPrompt,
   });
   ```
-  ### Run processing message
+  ### Process user messages
   ```js
   const messages = [{ role: 'user', content: 'First message!' }]
   const response = await app.processMessages(messages);

diff --git a/docs/src/docs/integrations/slack-usage.md b/docs/src/docs/integrations/slack-usage.md
@@ -28,6 +28,9 @@ received from slack endpoint.
 slack.processEvent(event);
 ```
 
+We provide automatic parsing from slack event to our internal event. We also provide custom formatter to
+[slack blocks](https://api.slack.com/block-kit) that uses `slack-rich-text` package.
+
 ## Websocket mode
 
 Alternatively, you can use [Slack SDK](https://tools.slack.dev/bolt-js/concepts/socket-mode) ability to connect to Slack API using WebSockets. This can be helpful in cases when you want to setup your server in a setting without public IP connection and/or for development purposes.

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,7 +2,7 @@
 pageType: home
 
 hero:
-  name: byorg-ai
+  name: '<img alt="byorg.ai" className="home-hero-name-img" src="/img/logo_dark">'
   text: 'AI Assistants Framework'
   tagline: A framework to make development of your AI Assistant faster and easier.
   actions:

diff --git a/docs/src/public/img/favicon.ico b/docs/src/public/img/favicon.ico
diff --git a/docs/src/public/img/logo_dark.svg b/docs/src/public/img/logo_dark.svg
diff --git a/docs/src/public/img/logo_light.svg b/docs/src/public/img/logo_light.svg
diff --git a/docs/src/public/img/logo_mono_dark.svg b/docs/src/public/img/logo_mono_dark.svg
diff --git a/docs/src/public/img/logo_mono_light.svg b/docs/src/public/img/logo_mono_light.svg