參與文件貢獻

Osprey 文件網站使用 mdBook 建立並部署至 GitHub Pages。合併至 main branch 的變更會自動建立及部署。

既有頁面可以直接在 GitHub 網頁介面編輯，也可以使用文件網站上方的 🖉 Suggest an edit 圖示。建立新頁面時，必須同步更新 SUMMARY.md。完成修改後，依其他 GitHub 專案的方式提出 pull request 供審查。

mdBook 的結構請參考官方說明中的 anatomy of a book。

文件準則

為了維持不同專案之間的一致性並降低參與門檻，Osprey 盡可能遵循 ROOST 社群文件準則。

本機開發

若要在本機建立網站，先 clone repository 並安裝 mdbook。安裝方式請見官方說明。

完成後，在 repository root 使用 mdbook command。下列範例會持續監看變更、建立網站並提供本機服務。

mdbook serve docs

修改後，在瀏覽器開啟 http://localhost:3000 預覽，再依一般流程 commit、push 並提出 pull request。

繁中工作區使用獨立的 book.toml 與來源狀態清單。修改繁中內容後，另須執行 ./localization/zh-Hant-TW/scripts/check-all.sh，確認來源、用語、忠實度、建置與內部連結。