docs: add some starter doc

oramasearch · Jul 22, 2024 · 7543a46 · 7543a46
1 parent ee8f107
commit 7543a46
Show file tree

Hide file tree

Showing 6 changed files with 10,202 additions and 12,296 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,48 @@
-# TODO
+# Orama UI Components
+
+## Table of Contents
+
+1. [Introduction](#introduction)
+2. [Getting Started](#getting-started)
+   - [Installation](#installation)
+3. [Components](#components)
+   - [Chatbox: `Chatbox`](#chatbox)
+4. [Contributing](#contributing)
+
+## Introduction
+
+Welcome to the **Orama UI Components Library**! This library provides a set of reusable UI components for easily implementing search functionalities in your web applications.
+
+## Getting Started
+
+### Installation
+
+To get started with our components, you need to install the library via npm:
+
+```bash
+npm install @orama/ui-components
+# TODO: placeholder
+```
+
+### Authentication
+
+Since most of our components require you to have a cloud index already deployed, make sure to:
+
+1. **Sign Up**: Go to [Our Signup Page](https://cloud.oramasearch.com/auth/signup) and create an account.
+2. **Create your first index**: You can even create a Demo index to start playing around
+
+## Components
+
+### Chatbox: `Chatbox`
+
+**Description**: This component enables you to swiftly set up an entire Retrieval-Augmented Generation (RAG) system in just under 3 minutes. It leverages the answer engine to enhance content generation.
+
+**Usage**:
+
+```html
+<orama-chat-box index="value"></orama-chat-box>
+```
+
+## Contributing
+
+We welcome contributions from the community! Please read our [Contributing Guide](./contributing.md) to learn how you can help improve this project.
diff --git a/contributing.md b/contributing.md
@@ -0,0 +1 @@
+# todo
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
     "build": "turbo run build",
     "clean": "turbo run clean",
     "dev": "turbo run dev --filter=ui-stencil --filter=storybook",
+    "dev:all": "turbo run dev",
     "format": "prettier --write \"**/*.{ts,tsx,md}\"",
     "lint": "turbo run lint",
     "maintenance": "turbo run maintenance"
@@ -19,5 +20,10 @@
     "prettier": "^3.3.2",
     "turbo": "^2.0.5"
   },
-  "packageManager": "[email protected]"
+  "engines": {
+    "node": ">=20",
+    "yarn": "Please use pnpm instead of Yarn to install dependencies",
+    "pnpm": ">=8.10.0"
+  },
+  "packageManager": "[email protected]"
 }
diff --git a/...a-chat-messages-container/orama-chat-assistent-message/orama-markdown/orama-markdown.scss b/...a-chat-messages-container/orama-chat-assistent-message/orama-markdown/orama-markdown.scss
@@ -3,7 +3,7 @@ pre > code {
 }
 
 :host {
-  color: var(--text-color-secondary, text-color(-secondary));
+  color: var(--text-color-secondary, text-color(secondary));
 }
 
 .orama-markdown-code {

diff --git a/packages/ui-stencil/src/components/orama-search-box/readme.md b/packages/ui-stencil/src/components/orama-search-box/readme.md
@@ -11,7 +11,7 @@
 | `colorScheme`   | `color-scheme`   |             | `"dark" \| "light" \| "system"`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | `'light'`   |
 | `facetProperty` | `facet-property` |             | `string`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | `undefined` |
 | `open`          | `open`           |             | `boolean`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | `false`     |
-| `resultMap`     | --               |             | `{ title?: string; description?: string; path?: string; section?: string; }`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | `{}`        |
+| `resultMap`     | --               |             | `{ section?: string; title?: string; path?: string; description?: string; }`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | `{}`        |
 | `themeConfig`   | --               |             | `{ typography?: DeepPartial<{ '--font-primary': string; }>; colors?: DeepPartial<{ light: { '--text-color-primary': string; '--text-color-secondary': string; '--text-color-teriary': string; '--text-color-inactive': string; '--background-color-primary': string; '--background-color-secondary': string; '--background-color-tertiary': string; '--background-color-fourth': string; '--border-color-primary': string; '--border-color-secondary': string; '--border-color-inactive': string; '--icon-color-primary': string; '--icon-color-secondary': string; '--icon-color-tertiary': string; '--icon-color-inactive': string; '--icon-color-accent': string; }; dark: { '--text-color-primary': string; '--text-color-secondary': string; '--text-color-teriary': string; '--text-color-inactive': string; '--background-color-primary': string; '--background-color-secondary': string; '--background-color-tertiary': string; '--background-color-fourth': string; '--border-color-primary': string; '--border-color-secondary': string; '--border-color-inactive': string; '--icon-color-primary': string; '--icon-color-secondary': string; '--icon-color-tertiary': string; '--icon-color-inactive': string; '--icon-color-accent': string; }; system: {}; }>; }` | `undefined` |
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,7 +3,7 @@ pre > code { @@
     }
     :host {
-      color: var(--text-color-secondary, text-color(-secondary));
+      color: var(--text-color-secondary, text-color(secondary));
     }
     .orama-markdown-code {
@@ Expand Down @@