Skip to content

README 瘦身與 ARCHITECTURE 文件 - #52

Merged
tim32503 merged 1 commit into
mainfrom
docs/readme-slim
Sep 1, 2026
Merged

tim32503 merged 1 commit into
mainfrom
docs/readme-slim

Conversation

@tim32503

@tim32503 tim32503 commented Sep 1, 2026

Copy link
Copy Markdown
Owner

需求說明

README 已成長到 362 行、門面與百科混雜。依「不開 wiki、docs/ 就是展示品」的決策重構。

變更內容

  • README(108 行):一頁式作品集門面——Live Demo/GIF、5 條精選重構亮點、技術棧、本機 quickstart(含 operator/viewer 帳號與密碼澄清)、測試指令、11 份文件導覽表、素材授權、已知限制精簡版
  • docs/ARCHITECTURE.md(新,285 行):架構總覽(Models/ERD/刻意保留的非正規/路由/前端/CSS)、完整版亮點與新增功能、已知限制與部署細節全文;顯式 <a id> 錨點避免中文標題 slug 問題
  • 舊 README 每一段的去處都有對照(PR 內容零蒸發),站內連結與錨點逐一驗證存在

純文件變更;bin/rails test 222 runs 全綠確認未波及。

- README 362 行 → 108 行:Live Demo/GIF、5 條精選亮點、技術棧、
  quickstart 與帳號資訊、測試指令、11 份文件導覽表、授權註記
- 新增 docs/ARCHITECTURE.md(285 行,含目錄與顯式錨點):架構
  總覽、完整亮點論述、刻意保留的非正規設計、新增功能全文、
  已知限制與部署細節——內容零刪減、僅重新歸位
@tim32503 tim32503 self-assigned this Sep 1, 2026
@tim32503
tim32503 merged commit f1e4f71 into main Sep 1, 2026
4 checks passed
@tim32503
tim32503 deleted the docs/readme-slim branch September 1, 2026 09:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant