Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update tech stacks and roadmap #178

Merged
merged 5 commits into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .github/workflows/verify.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@ on:
push:
branches:
- main
paths:
- frontend/**
- README.md
pull_request:
branches:
- main
paths:
- frontend/**
- README.md

jobs:
verify-frontend:
Expand All @@ -20,6 +26,13 @@ jobs:
uses: actions/checkout@v4
- uses: pnpm/action-setup@v4
with:
run_install: true
run_install: false
package_json_file: ./frontend/package.json
- name: Install Node.js
uses: actions/setup-node@v4
with:
node-version-file: ./frontend/.nvmrc
cache-dependency-path: ./frontend
cache: 'pnpm'
- run: pnpm i --frozen-lockfile
- run: pnpm run verify
17 changes: 5 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@
## Introduction
A conversational search tool based on GraphRAG (Knowledge Graph) that built on top of [TiDB Vector](https://tidb.cloud/ai) and [LlamaIndex](https://github.com/run-llama/llama_index) and [DSPy](https://github.com/stanfordnlp/dspy).

**Live Demo**: [TiDB.AI](https://tidb.cloud/?utm_source=github&utm_medium=tidb.ai)

**Documentation**: [TiDB.AI Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai)
* **Live Demo**: [TiDB.AI](https://tidb.cloud/?utm_source=github&utm_medium=tidb.ai)
* **Documentation**: [Docs](https://tidb.ai/docs/?utm_source=github&utm_medium=tidb.ai)

## Features
1. **Perplexity-style Conversational Search page**: Our platform features an advanced built-in website crawler, designed to elevate your browsing experience. This crawler effortlessly navigates official and documentation sites, ensuring comprehensive coverage and streamlined search processes through sitemap URL scraping.
Expand All @@ -27,17 +26,11 @@ You can even edit the Knowledge Graph to add more information or correct any ina


## Tech Stack
- [Next.js](https://nextjs.org/) – Framework
- [TypeScript](https://www.typescriptlang.org/) – Language
- [Tailwind](https://tailwindcss.com/) – CSS
- [shadcn/ui](https://ui.shadcn.com/) - Design
- [TiDB](https://tidb.cloud/) – Database to store chat history, vector, json, and analytic
- [Kysely](https://kysely.dev/) - SQL query builder
- [NextAuth.js](https://next-auth.js.org/) – Auth
- [Vercel](https://vercel.com/) – Deployments
- [TiDB](https://pingcap.com/ai/?utm_source=github&utm_medium=tidb.ai) – Database to store chat history, vector, json, and analytic
- [LlamaIndex](https://www.llamaindex.ai/) - RAG framework
- [DSPy](https://github.com/stanfordnlp/dspy) - The framework for programming—not prompting—foundation models
- [TiDB Vector](https://tidb.cloud/ai) - Vector storage and search engine
- [Next.js](https://nextjs.org/) – Framework
- [shadcn/ui](https://ui.shadcn.com/) - Design

## Contect Us
You can post topics on our [TiDB Community](https://ask.pingcap.com/) page.
Expand Down
44 changes: 0 additions & 44 deletions frontend/app/src/pages/docs/README.md

This file was deleted.

1 change: 1 addition & 0 deletions frontend/app/src/pages/docs/README.md
7 changes: 7 additions & 0 deletions frontend/app/src/pages/docs/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@

Latest updates and announcements.

## July 22nd, 2024 - Refactor core from JavaScript to Python

- **Core Enhancements:**
- Refactor the core from JavaScript to Python.
- [x] Graph RAG (Knowledge Graph) core
- [x] LlamaIndex core

## May 29th, 2024 - Add Knowledge Graph as secondary set of corpus

- **Core Enhancements:**
Expand Down
2 changes: 1 addition & 1 deletion frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "tidb-ai-parent",
"private": true,
"version": "0.0.0",
"packageManager": "pnpm@9.4.0",
"packageManager": "pnpm@9.6.0",
"license": "Apache-2.0",
"scripts": {
"test": "pnpm run --filter '*' test",
Expand Down