Newer
Older
TelosDB / docs / specification / 05_development_guide.md
@楽曲作りまくりおじさん 楽曲作りまくりおじさん 18 hours ago 2 KB docs: reformat bilingual documents into separate blocks

TelosDB 開発ガイド (Development Guide)

日本語 (Japanese)

本ドキュメントは、TelosDB エンジンのビルド、拡張、および内部構造に関する技術的なガイドラインを提供します。

1. ディレクトリ構造

  • src/frontend/: React/Vite ベースの UI コンポーネント。
  • src/backend/: Rust/Tauri ベースのコアエンジンおよび MCP サーバー。
  • docs/specification/: システム仕様書(DB、API、UIデザイン等)。
  • .agent/rules/: AI エージェント用プロジェクト運用ルール。

2. バックエンド開発

  • データベース: sqlite-vec を利用したベクトル検索および LSA による次元圧縮を実装しています。
  • MCP サーバー: mcp.rs にて外部ツール(Claude 等)向けのインターフェースを定義しています。
  • 次元圧縮 (LSA): lsa.rs にて SVD を用いたベクトルの次元圧縮を行い、検索の高速化と精度向上を実現しています。

3. フロントエンド開発

  • 通信: Tauri の invoke および listen を用いてバックエンドと非同期通信を行います。
  • UI コンポーネント: Vanilla CSS および一部の現代的な CSS 手法を用いた、プレミアムな UI デザインを採用しています。

English

This document provides technical guidelines for building, extending, and understanding the internal structure of the TelosDB engine.

1. Directory Structure

  • src/frontend/: React/Vite-based UI components.
  • src/backend/: Rust/Tauri-based core engine and MCP server.
  • docs/specification/: System specifications (DB, API, UI design, etc.).
  • .agent/rules/: Project operational rules for AI agents.

2. Backend Development

  • Database: Implements vector search using sqlite-vec and dimensionality reduction via LSA (Latent Semantic Analysis).
  • MCP Server: Defines interfaces for external tools (e.g., Claude) in mcp.rs.
  • Dimensionality Reduction (LSA): Performs vector compression using SVD in lsa.rs to improve search speed and accuracy.

3. Frontend Development

  • Communication: Uses Tauri's invoke and listen for asynchronous communication with the backend.
  • UI Components: Employs premium UI design utilizing Vanilla CSS and modern CSS techniques.