Skip to content

Commit

Permalink
Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
iipanda committed Oct 26, 2024
1 parent c6a2b33 commit f8bb735
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 270 deletions.
20 changes: 0 additions & 20 deletions apps/www/app/(app)/docs/[[...slug]]/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -142,26 +142,6 @@ export default async function DocPage({ params }: DocPageProps) {
<div className="sticky top-16 -mt-10 h-[calc(100vh-3.5rem)] pt-4">
<ScrollArea className="h-full pb-10">
{doc.toc && <DashboardTableOfContents toc={toc} />}

<div className="group relative mt-6 flex max-w-[80%] flex-col gap-2 rounded-lg border p-4 text-sm">
<div className="text-balance text-lg font-semibold leading-tight group-hover:underline">
Get your AI application built by Next.js experts
</div>
<div>
Blazity is a team of extremely skilled Next.js engineers and
open-source contributors. We help companies build and ship
enterprise-ready web solutions.
</div>
<Button size="sm" className="mt-2 w-fit">
Check us out
</Button>
<Link
href="https://blazity.com/new?utm_source=opensource&utm_medium=web&utm_campaign=shadcn-chatbot-kit"
target="_blank"
rel="noreferrer"
className="absolute inset-0"
/>
</div>
</ScrollArea>
</div>
</div>
Expand Down
1 change: 0 additions & 1 deletion apps/www/components/mdx-components.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import { ComponentPreview } from "@/components/component-preview"
import { ComponentSource } from "@/components/component-source"
import { CopyButton, CopyNpmCommandButton } from "@/components/copy-button"
import { FrameworkDocs } from "@/components/framework-docs"
import { StyleWrapper } from "@/components/style-wrapper"
import {
Accordion,
AccordionContent,
Expand Down
5 changes: 0 additions & 5 deletions apps/www/config/docs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,6 @@ export const docsConfig: DocsConfig = {
href: "/docs/installation",
items: [],
},
{
title: "CLI",
href: "/docs/cli",
items: [],
},
],
},
{
Expand Down
104 changes: 0 additions & 104 deletions apps/www/content/docs/cli.mdx

This file was deleted.

67 changes: 38 additions & 29 deletions apps/www/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,66 +1,75 @@
---
title: Introduction
description: Beautifully designed components that you can copy and paste into your apps. Accessible. Customizable. Open Source.
description: A comprehensive chatbot component kit built on top of shadcn/ui ecosystem.
---

This is **NOT** a component library. It's a collection of re-usable components that you can copy and paste into your apps.
If you're not familiar with [shadcn/ui](https://ui.shadcn.com/), we encourage you to take a look at its docs to learn more about it.

**What do you mean by not a component library?**

I mean you do not install it as a dependency. It is not available or distributed via npm.

Pick the components you need. Copy and paste the code into your project and customize to your needs. The code is yours.

_Use this as a reference to build your own component libraries._
This collection of components is heavily inspired by `shadcn/ui` and uses its CLI to aid with automatically installing components.

## FAQ

<Accordion type="multiple">

<AccordionItem value="faq-1">
<AccordionTrigger>
Why copy/paste and not packaged as a dependency?
</AccordionTrigger>
<AccordionContent>
The idea behind this is to give you ownership and control over the code, allowing you to decide how the components are built and styled.

Start with some sensible defaults, then customize the components to your needs.

One of the drawbacks of packaging the components in an npm package is that the style is coupled with the implementation. _The design of your components should be separate from their implementation._

</AccordionContent>
<AccordionTrigger>Is this an official shadcn project?</AccordionTrigger>
<AccordionContent>
No, this is not an official shadcn/ui project. This is a component kit built
by Blazity, that follows shadcn/ui's design philosophy and methodology.
We've built it to be fully compatible with the shadcn/ui ecosystem, allowing
you to seamlessly integrate it with existing shadcn/ui components while
maintaining the same level of customization and control over your code.
</AccordionContent>
</AccordionItem>

<AccordionItem value="faq-2">
<AccordionTrigger>
Do you plan to publish it as an npm package?
How does the AI integration work?
</AccordionTrigger>
<AccordionContent>
No. I have no plans to publish it as an npm package.
The kit is designed to work seamlessly with the Vercel AI SDK out of the box, making it easy to integrate with popular AI providers. Simply use the `useChat` hook from the Vercel AI SDK, and pass the returned properties to our Chat component.

However, you're not limited to the Vercel AI SDK. The components are built to be provider-agnostic, allowing you to implement your own custom AI integration.

</AccordionContent>
</AccordionItem>

<AccordionItem value="faq-3">
<AccordionTrigger>
Which frameworks are supported?
What features are included out of the box?
</AccordionTrigger>
<AccordionContent>

You can use any framework that supports React. [Next.js](https://ui.shadcn.com/docs/installation/next), [Astro](https://ui.shadcn.com/docs/installation/astro), [Remix](https://ui.shadcn.com/docs/installation/remix), [Gatsby](https://ui.shadcn.com/docs/installation/gatsby) etc.
The kit includes several key features:
- Auto-scroll message area with smart scrolling behavior
- Auto-resize message input with file upload support
- Built-in prompt suggestions
- Message actions (copy, rate response, etc.)
- Elegant loading states and transitions
- Markdown support and code syntax highlighting in messages
- File attachments and image preview
- Dark mode support
- TypeScript support

All components can be used as-is or customized to match your specific requirements.

</AccordionContent>
</AccordionItem>

<AccordionItem value="faq-4">
<AccordionTrigger>
Can I use this in my project?
How do I get started?
</AccordionTrigger>
<AccordionContent>
Yes. Free to use for personal and commercial projects. No attribution required.
Getting started is straightforward:

But hey, let me know if you do. I'd love to see what you build.
1. First, set up shadcn/ui in your project following their installation guide
2. Use the modern `shadcn` CLI to install our components
3. If you're using Vercel AI SDK, import the `useChat` hook and pass it to our Chat component
4. If you're using a custom implementation, follow our interface guide to integrate your AI service

</AccordionContent>
The components are tree-shakeable and work with any framework that supports React 18 or higher, including Next.js, Remix, Astro, and Gatsby.

</AccordionContent>

</AccordionItem>

Expand Down
111 changes: 0 additions & 111 deletions apps/www/content/docs/installation/remix.mdx

This file was deleted.

0 comments on commit f8bb735

Please sign in to comment.