Skip to content

Commit

Permalink
📖 DOC: main doc simplified
Browse files Browse the repository at this point in the history
  • Loading branch information
fancn21th committed Feb 13, 2025
1 parent f2383f0 commit 1f72ed2
Show file tree
Hide file tree
Showing 3 changed files with 35 additions and 34 deletions.
46 changes: 12 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,40 +67,6 @@ pnpm build
- 在 设计系统层面 进行 横向的扩展
- 基于 AI SDK 的 custom provider 提供模型的扩展

## 设计思想

- 第一性原理

- 拆解问题:将复杂的问题分解成更小、更基本的部分。
- 寻找基本事实:找到这些部分中最基本、最确定的事实和原理。
- 重建解决方案:基于这些基本事实和原理,重新构建解决方案,而不是依赖现有的假设和惯例。

- 大道至简

- 苹果和特斯拉的成功就是简化了复杂的事物, 将复杂度从用户的角度进行了转移

- 无处不代理

- 代理模式可以降低 耦合度
- 代理的泛化
- 代理的目的是为了解耦, 但是代理的实现可以是多种多样的 简而言之 不直接依赖 间接依赖就是代理

- 不要轻易深入到细节设计, 先完成最重要的设计

- 细节可以后续再设计与优化

## 技术实现

- 设计系统 与 组件库

- radix ui
- shadcn/ui
- storybook

- 聊天应用
- ai sdk
- next.js

## 项目结构

```
Expand All @@ -127,3 +93,15 @@ pnpm build
## 改进项目

整个项目的推进以业务优先, 但是一些改进项目也需要跟踪, 参考 [todo](./docs/todo.md)

## 技术实现

- 设计系统 与 组件库

- radix ui
- shadcn/ui
- storybook

- 聊天应用
- ai sdk
- next.js
21 changes: 21 additions & 0 deletions docs/design-principles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# 设计思想

- 第一性原理

- 拆解问题:将复杂的问题分解成更小、更基本的部分。
- 寻找基本事实:找到这些部分中最基本、最确定的事实和原理。
- 重建解决方案:基于这些基本事实和原理,重新构建解决方案,而不是依赖现有的假设和惯例。

- 大道至简

- 苹果和特斯拉的成功就是简化了复杂的事物, 将复杂度从用户的角度进行了转移

- 无处不代理

- 代理模式可以降低 耦合度
- 代理的泛化
- 代理的目的是为了解耦, 但是代理的实现可以是多种多样的 简而言之 不直接依赖 间接依赖就是代理

- 不要轻易深入到细节设计, 先完成最重要的设计

- 细节可以后续再设计与优化
2 changes: 2 additions & 0 deletions docs/flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

- [Like drawing a circle](./flow.circle.md)

- [设计思想](./design-principles.md)

## v0.1.0

> done
Expand Down

0 comments on commit 1f72ed2

Please sign in to comment.