docs: new org (#1331)

This commit is contained in:
Simon Farshid
2025-01-08 00:51:28 -08:00
committed by GitHub
parent 9a3dc93c86
commit 8d2f800bbb
29 changed files with 63 additions and 50 deletions
+2 -2
View File
@@ -1,5 +1,5 @@
<a href="https://www.assistant-ui.com">
<img src="https://raw.githubusercontent.com/Yonom/assistant-ui/main/.github/assets/header.svg" alt="assistant-ui Header" width="100%" style="width: 1000px" />
<img src="https://raw.githubusercontent.com/assistant-ui/assistant-ui/main/.github/assets/header.svg" alt="assistant-ui Header" width="100%" style="width: 1000px" />
</a>
<p align="center">
@@ -16,7 +16,7 @@ Wide model provider support (OpenAI, Anthropic, Mistral, Perplexity, AWS Bedrock
## Quick Start
[![assistant-ui starter template](https://raw.githubusercontent.com/Yonom/assistant-ui/main/.github/assets/assistant-ui-starter.gif)](https://youtu.be/k6Dc8URmLjk)
[![assistant-ui starter template](https://raw.githubusercontent.com/assistant-ui/assistant-ui/main/.github/assets/assistant-ui-starter.gif)](https://youtu.be/k6Dc8URmLjk)
Step 1: Create a new project with `assistant-ui` pre-configured:
+1 -1
View File
@@ -2,6 +2,6 @@
We security bugs in assistant-ui seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.
To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/Yonom/assistant-ui/security/advisories/new) tab.
To report a security issue, please use the GitHub Security Advisory ["Report a Vulnerability"](https://github.com/assistant-ui/assistant-ui/security/advisories/new) tab.
Our team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix and full announcement, and may ask for additional information or guidance.
+10 -6
View File
@@ -12,7 +12,9 @@ const Examples = () => {
</a>
</li>
<li>
<a href="https://github.com/Yonom/assistant-ui-rsc-example">Code</a>
<a href="https://github.com/assistant-ui/assistant-ui-rsc-example">
Code
</a>
</li>
</ul>
@@ -28,7 +30,7 @@ const Examples = () => {
</a>
</li>
<li>
<a href="https://github.com/Yonom/assistant-ui/tree/main/examples/search-agent-for-e-commerce">
<a href="https://github.com/assistant-ui/assistant-ui/tree/main/examples/search-agent-for-e-commerce">
Code
</a>
</li>
@@ -38,7 +40,7 @@ const Examples = () => {
<p>This is an example of how to use inline suggestions.</p>
<ul>
<li>
<a href="https://github.com/Yonom/assistant-ui/tree/main/examples/with-inline-suggestions">
<a href="https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-inline-suggestions">
Code
</a>
</li>
@@ -53,7 +55,7 @@ const Examples = () => {
</a>
</li>
<li>
<a href="https://github.com/Yonom/assistant-ui/tree/main/examples/with-react-hook-form">
<a href="https://github.com/assistant-ui/assistant-ui/tree/main/examples/with-react-hook-form">
Code
</a>
</li>
@@ -66,7 +68,9 @@ const Examples = () => {
</p>
<ul>
<li>
<a href="https://github.com/Yonom/assistant-ui-custom-api">Code</a>
<a href="https://github.com/assistant-ui/assistant-ui-custom-api">
Code
</a>
</li>
</ul>
@@ -77,7 +81,7 @@ const Examples = () => {
</p>
<ul>
<li>
<a href="https://github.com/Yonom/assistant-ui-assistant-api-history">
<a href="https://github.com/assistant-ui/assistant-ui-assistant-api-history">
Code
</a>
</li>
+1 -1
View File
@@ -50,7 +50,7 @@ function Footer(): React.ReactElement {
<FooterLink href="https://discord.gg/S9dwgCNEFs">
Discord
</FooterLink>
<FooterLink href="https://github.com/Yonom/assistant-ui">
<FooterLink href="https://github.com/assistant-ui/assistant-ui">
GitHub
</FooterLink>
<FooterLink href="https://cal.com/simon-farshid/assistant-ui">
+1 -1
View File
@@ -112,7 +112,7 @@ export default function HomePage() {
</a>
<a
className={buttonVariants({ variant: "outline" })}
href="https://github.com/Yonom/assistant-ui"
href="https://github.com/assistant-ui/assistant-ui"
>
🌟 Star us on Github
</a>
+1 -1
View File
@@ -86,7 +86,7 @@ const SHOWCASE_ITEMS: ShowcaseItem[] = [
tag: "Developer Tools",
link: "https://assistant-ui-stockbroker.vercel.app/",
announcementLink: "https://blog.langchain.dev/assistant-ui/",
repositoryLink: "https://github.com/Yonom/assistant-ui-stockbroker",
repositoryLink: "https://github.com/assistant-ui/assistant-ui-stockbroker",
description: "Research financial data about public companies",
secondaryTag: "OSS",
},
+1 -1
View File
@@ -22,7 +22,7 @@ export default async function Page(props: {
const footer = (
<a
href={`https://github.com/Yonom/assistant-ui/blob/main/${path}`}
href={`https://github.com/assistant-ui/assistant-ui/blob/main/${path}`}
target="_blank"
rel="noreferrer noopener"
className={cn(
+1 -1
View File
@@ -27,7 +27,7 @@ const DiscordIcon = () => {
// shared configuration
export const baseOptions: HomeLayoutProps = {
githubUrl: "https://github.com/Yonom/assistant-ui",
githubUrl: "https://github.com/assistant-ui/assistant-ui",
nav: {
title: (
<>
@@ -36,7 +36,7 @@ It didn't take long for developers to start building with assistant-ui. Here are
- [myresume.guru](http://myresume.guru) - AI resume optimizer to land your dream job
- [Entelligence](https://entelligence.ai/) - AI mentor for software engineers
With 250+ stars on [GitHub](https://github.com/Yonom/assistant-ui) and over 1k [npm](https://www.npmjs.com/package/@assistant-ui/react) weekly downloads, we got a vibrant growing community of developers who care about the user experience.
With 250+ stars on [GitHub](https://github.com/assistant-ui/assistant-ui) and over 1k [npm](https://www.npmjs.com/package/@assistant-ui/react) weekly downloads, we got a vibrant growing community of developers who care about the user experience.
<Image
src={npmDownloads}
@@ -21,7 +21,7 @@ This agent leverages the following features:
## Final Result
- Demo: https://assistant-ui-stockbroker.vercel.app/
- Source Code: https://github.com/Yonom/assistant-ui-stockbroker
- Source Code: https://github.com/assistant-ui/assistant-ui-stockbroker
## Get Started
@@ -50,7 +50,7 @@ NEXT_PUBLIC_LANGGRAPH_ASSISTANT_ID=stockbroker
This connects the frontend to a LangGraph Cloud endpoint running under
`https://assistant-ui-stockbroker.vercel.app/api`.
This endpoint is running the LangGraph agent defined [in this repository](https://github.com/Yonom/assistant-ui-stockbroker/blob/main/backend).
This endpoint is running the LangGraph agent defined [in this repository](https://github.com/assistant-ui/assistant-ui-stockbroker/blob/main/backend).
### Start the server
@@ -18,7 +18,7 @@ import price from "./images/acme-price.png";
For reference, this the corresponding code in the backend:
https://github.com/Yonom/assistant-ui-stockbroker/blob/main/backend/src/tools.ts#L193C1-L216C3
https://github.com/assistant-ui/assistant-ui-stockbroker/blob/main/backend/src/tools.ts#L193C1-L216C3
```ts title="assistant-ui-stockbroker/backend/tools/PriceSnapshotTool.ts"
export const priceSnapshotTool = tool(
@@ -1,32 +1,37 @@
## Getting Started
1. Clone the repository:
```sh
git clone https://github.com/Yonom/assistant-ui.git
git clone https://github.com/assistant-ui/assistant-ui.git
```
2. Navigate to the project directory:
```sh
cd assistant-ui/examples/search-agent-for-e-commerce
```
3. Create a `.env` file with the following variable:
```sh
OPENAI_API_KEY="skXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
```
4. Make the `start.sh` script executable:
```sh
chmod +x start.sh
```
5. Start the servers:
```sh
./start.sh
```
6. Open the dummy e-commerce website in your browser:
[http://localhost:8080/dummy-ecommerce-website.html](http://localhost:8080/dummy-ecommerce-website.html)
[http://localhost:8080/dummy-ecommerce-website.html](http://localhost:8080/dummy-ecommerce-website.html)
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+4 -1
View File
@@ -165,7 +165,10 @@ export default function Home() {
<div className="border-b">
<p className="my-4 ml-8 text-xl font-bold">
ConvertGPT (built with{" "}
<a href="https://github.com/Yonom/assistant-ui" className="underline">
<a
href="https://github.com/assistant-ui/assistant-ui"
className="underline"
>
assistant-ui
</a>
)
+1 -1
View File
@@ -61,7 +61,7 @@ export default function Home() {
<div className="my-4 font-bold">
Built with{" "}
<Link
href="https://github.com/Yonom/assistant-ui"
href="https://github.com/assistant-ui/assistant-ui"
className="text-blue-600 underline"
>
assistant-ui
+2 -2
View File
@@ -51,10 +51,10 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
},
"dependencies": {
"nanoid": "^5.0.9",
+2 -2
View File
@@ -30,9 +30,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+3 -2
View File
@@ -51,8 +51,9 @@ export const create = new Command()
)
.action((_, opts) => {
const templates = {
default: "https://github.com/Yonom/assistant-ui-starter",
langgraph: "https://github.com/Yonom/assistant-ui-starter-langgraph",
default: "https://github.com/assistant-ui/assistant-ui-starter",
langgraph:
"https://github.com/assistant-ui/assistant-ui-starter-langgraph",
};
const templateUrl =
+2 -2
View File
@@ -32,9 +32,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -56,9 +56,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -53,9 +53,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -52,9 +52,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -79,9 +79,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -80,9 +80,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
@@ -56,9 +56,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -88,9 +88,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -134,9 +134,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "https://github.com/Yonom/assistant-ui/tree/main/packages/react"
"url": "https://github.com/assistant-ui/assistant-ui/tree/main/packages/react"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -50,9 +50,9 @@
"homepage": "https://www.assistant-ui.com/",
"repository": {
"type": "git",
"url": "git+https://github.com/Yonom/assistant-ui.git"
"url": "git+https://github.com/assistant-ui/assistant-ui.git"
},
"bugs": {
"url": "https://github.com/Yonom/assistant-ui/issues"
"url": "https://github.com/assistant-ui/assistant-ui/issues"
}
}
+2 -2
View File
@@ -17,8 +17,8 @@ classifiers = [
]
[project.urls]
Homepage = "https://github.com/Yonom/assistant-ui"
Issues = "https://github.com/Yonom/assistant-ui/issues"
Homepage = "https://github.com/assistant-ui/assistant-ui"
Issues = "https://github.com/assistant-ui/assistant-ui/issues"
[tool.poetry]
name = "assistant-stream"