撰寫文件

以下是為 BeeWare 撰寫文件貢獻的步驟。

在開始撰寫文件之前，請確保您能夠建立文件，並且您正在工作分支上進行作業。

更新現有文件

如果您要編輯現有的說明文件，您需要在 /docs/en 目錄中找到該檔案。檔案結構遵循頁面結 構，因此您可以使用說明文件 URL 來定位檔案。

新增文件

如果您要新增一個新文件，還需要一些步驟。

您需要在 docs/en 目錄中的適當位置建立文件。為了方便討論，我們假設您要新增一個文件名為 new_doc.md的新文件。

然後，您需要更新 docs/en/SUMMARY.md 檔案，以包含您的新檔案。SUMMARY.md 的組織基本上反映了 docs/en 目錄的結構，但更重要的是，它直接決定了左側欄的結構。如果您找到打算包含 new_doc.md 的部分，如果看到列出的通配符路徑，您不需要在 SUMMARY.md 中做任何修改。例如

- ./path/to/directory/*

如果您打算包含 new_doc.md 的部分是個別 Markdown 連結的清單，您就需要在您的部分加入明確的連結。例如

- [My new document](new_doc.md)

撰寫您的文件

現在您可以在編輯器中開啟所需的檔案，並開始撰寫。

我們有一份 文件風格指南，概述了我們為 BeeWare 撰寫文件的準則。

當您對新文件感到滿意後，即可提交拉取請求，附上您建議的修改內容。