Chester 開發文檔

本節包含 Chester 實現細節和開發說明的技術文檔。

These documents are made for both llm and human.

文檔結構

我們使用 mdBook 來組織和展示我們的文檔。文檔結構如下：

文檔管理

文檔結構通過以下幾種工具進行管理：

1. SUMMARY.md 生成：

   • SUMMARY.md 文件是使用 dev.sh 腳本自動生成的
   • 更新摘要：cd docs && ./dev.sh summary
   • 請勿直接編輯 SUMMARY.md，因為變更將被覆蓋

2. 構建文檔：

   • 使用 mdBook 構建和預覽變更
   • dev.sh 腳本提供各種文檔管理命令

貢獻

添加新的開發文檔時：

1. 在 docs/src/dev/ 下的適當子目錄中創建您的 markdown 文件
2. 將開發相關文檔放在 dev/ 目錄中
3. 遵循現有的文檔風格和結構
4. 在適當的地方包含代碼示例
5. 添加新的主要組件時更新此 README.md
6. 運行 ./dev.sh summary 來更新文檔結構